Skip to content

Commit 2baf03c

Browse files
committed
Finish markdown lint fixes in example README
1 parent df049d3 commit 2baf03c

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

example/README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# A demo app for using Solid Auth package
22

3-
Flutter Demo app for authenticate with Solid PODs. The app can run on both mobile (tested on Anroid) and web platforms (tested on Chrome and Firefox).
3+
Flutter Demo app for authenticate with Solid PODs. The app can run on
4+
both mobile (tested on Anroid) and web platforms (tested on Chrome and
5+
Firefox).
46

57
<!-- **Flutter packages used in the app:**
68
@@ -19,13 +21,20 @@ Flutter Demo app for authenticate with Solid PODs. The app can run on both mobil
1921
- uuid: ^3.0.4
2022
- openidconnect_platform_interface: ^1.0.3 -->
2123

22-
### Acknowledgement
24+
## Acknowledgement
2325

24-
Parts of this package (under `lib/src/openid`) are derived from the `openid_client` (https://pub.dev/packages/openid_client) package, with custom modifications to support the Solid OIDC authentication flow. We would like to acknowledge and thank the authors of `openid_client` for their valuable work, which made these adaptations possible.
26+
Parts of this package (under `lib/src/openid`) are derived from the
27+
[openid_client](https://pub.dev/packages/openid_client) package, with
28+
custom modifications to support the Solid OIDC authentication flow. We
29+
would like to acknowledge and thank the authors of `openid_client` for
30+
their valuable work, which made these adaptations possible.
2531

2632
## Usage
2733

28-
Fork the demo app in the `\example` directory into a local directory and open the `pubspec.yaml` file. Check whether the latest version of the package `solid_auth` is added under dependencies. Now run the following to get the necessary packages.
34+
Fork the demo app in the `\example` directory into a local directory
35+
and open the `pubspec.yaml` file. Check whether the latest version of
36+
the package `solid_auth` is added under dependencies. Now run the
37+
following to get the necessary packages.
2938

3039
```dart
3140
flutter pub get
@@ -34,21 +43,22 @@ flutter pub get
3443

3544
### Running the app on web or mobile
3645

37-
After all the required packages are imported, then first select the device you want the app to run. Then run the app by pressing `CTRL + F5`.
46+
After all the required packages are imported, then first select the
47+
device you want the app to run. Then run the app by pressing `CTRL +
48+
F5`.
3849

39-
To access public data of a POD input the WebID into the text area and click `READ PUBLIC INFO` button.
50+
To access public data of a POD input the WebID into the text area and
51+
click `READ PUBLIC INFO` button.
4052

41-
<center> <img src="assets/images/public_data.gif" alt="public data" height="600"> </center>
42-
<br/>
53+
![](assets/images/public_data.gif")
4354

44-
To login input the SOLID POD provider URL into the text area and click `LOGIN` button. After login you can edit the profile data.
55+
To login input the SOLID POD provider URL into the text area and click
56+
`LOGIN` button. After login you can edit the profile data.
4557

46-
<center> <img src="assets/images/login.gif" alt="public data" height="600"> </center>
47-
<br/>
58+
![](assets/images/login.gif)
4859

49-
<center> <img src="assets/images/edit_data.gif" alt="public data" height="600"> </center>
50-
<br/>
60+
![](assets/images/edit_data.gif)
5161

5262
To logout simply click the `LOGOUT` button.
5363

54-
<center> <img src="assets/images/logout.gif" alt="public data" height="600"> </center>
64+
![](assets/images/logout.gif)

0 commit comments

Comments
 (0)