Skip to content

Commit

Permalink
docs: updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cnouguier committed Nov 23, 2022
1 parent fa8adde commit 1848026
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ yarn add @kalisio/feathers-s3

The provided [example](./example/README.md) illustrates how to setup:
* a [server app](./example/app.mjs)

https://github.com/kalisio/feathers-s3/blob/fa8adde8181ccad740ed7fcfb92af1a5c43f9281/example/app.mjs#L1

* a [browser client app](./example/public/index.html).

_You can also have a look at the [tests](./test) in order to have different use cases of the library_.
Expand Down
2 changes: 1 addition & 1 deletion example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ cd example
node ./app.mjs
```

By default, the server is listening on port `3333`.
_By default, the server is listening on port `3333`. You can change it by settting the environment variable `PORT` to the desired value._

3. Connect to `localhost:3333`

0 comments on commit 1848026

Please sign in to comment.