Skip to content

Commit d94b246

Browse files
Update readme
1 parent c2460dd commit d94b246

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
22
1+
24

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,19 @@ A WebID is a URL you control and can use to sign in to Solid Apps.
1313

1414
Before running the app, set the `NEXT_PUBLIC_ADMIN_WEBID` environment variable in `.env.local`.
1515

16-
Environment variables
17-
---------------------
16+
### Creating a WebID
1817

19-
This project includes a `.env.example` file with the placeholders for environment variables used by the app (for example `NEXT_PUBLIC_BASE_URI`, `NEXT_PUBLIC_MANIFEST_RESOURCE_URI`, and `NEXT_PUBLIC_ADMIN_WEBID`).
18+
If you don't have a WebID, you can choose from the Pod Providers listed on https://solidproject.org/get_a_pod.
2019

21-
Copy the example to a local env file and edit values before running the app
20+
For example, you can signup for a WebID at https://start.inrupt.com/.
2221

23-
Note: `.env` and `.env.local` are ignored by git by default (see `.gitignore`), so you can keep private credentials locally without committing them. The `.env.example` file is safe to commit and documents which variables are required.
22+
## Setting Environment Variables
2423

25-
### Creating a WebID
24+
This project includes a `.env.example` file with the placeholders for environment variables used by the app: `NEXT_PUBLIC_BASE_URI`, `NEXT_PUBLIC_MANIFEST_RESOURCE_URI`, and `NEXT_PUBLIC_ADMIN_WEBID`.
2625

27-
If you don't have a WebID, you can choose from the Pod Providers listed on https://solidproject.org/get_a_pod.
26+
Copy the `.env.example` to `.env.local` and edit the values before running the app.
2827

29-
For example, you can signup for a WebID at https://start.inrupt.com/.
28+
Note: `.env` and `.env.local` are ignored by git by default (see `.gitignore`), so you can keep private credentials locally without committing them. The `.env.example` file is safe to commit and documents which variables are required.
3029

3130

3231
## Run the App
@@ -54,6 +53,3 @@ Solid specifications include definitions for a [standard storage API](https://so
5453
We stir away from hierarchical modelling, resource containment is designed to enable adequate access control of resources to serve functionality.
5554

5655
Manifests resources are publicly readable resources designed for traversal needs.
57-
58-
59-
##

0 commit comments

Comments
 (0)