Skip to content

Commit 0de40bc

Browse files
committed
Document that this is a browser library.
Closes #66.
1 parent 3eb6b2d commit 0de40bc

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The [Solid](https://solid.mit.edu/) project
77
allows people to use apps on the Web
88
while storing their data in their own data pod.
99

10-
`solid-auth-client` is a library that allows
10+
`solid-auth-client` is a browser library that allows
1111
your apps to securely log in to Solid data pods
1212
and read and write data from them.
1313

@@ -25,7 +25,8 @@ solid.auth.trackSession(session => {
2525
</script>
2626
```
2727

28-
In Node.js, run `npm install solid-auth-client` and then do:
28+
When developing for webpack in a Node.js environment,
29+
run `npm install solid-auth-client` and then do:
2930

3031
```javascript
3132
const auth = require('solid-auth-client')
@@ -38,6 +39,10 @@ auth.trackSession(session => {
3839
})
3940
```
4041

42+
Note that this library is intended for the browser.
43+
You can use Node.js as a development environment,
44+
but not for actually logging in and out or making requests.
45+
4146
## Functionality
4247
This library offers two main types of functionality:
4348
- `fetch` functionality to make authenticated HTTP requests to a Solid pod

0 commit comments

Comments
 (0)