BradNut/graphbrainz
1
0
Fork 0
mirror of https://github.com/BradNut/graphbrainz synced 2025-09-08 17:40:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more usage notes

Browse source
This commit is contained in:
Brian Beck 2016-11-27 11:29:13 -08:00
parent 5f0710e353
commit 99574c97f2
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -79,7 +79,9 @@ app.listen(3000);
The `graphbrainz` middleware function accepts the following options: The `graphbrainz` middleware function accepts the following options:
* **`client`**: A custom API client instance to use. See the * **`client`**: A custom API client instance to use. See the
[client submodule](src/api.js) for help with creating a custom instance. [client submodule](src/api.js) for help with creating a custom instance. You
probably only need to do this if you want to adjust the rate limit and retry
behavior.
* Any remaining options are passed along to the standard GraphQL middleware. * Any remaining options are passed along to the standard GraphQL middleware.
See the [express-graphql][] documentation for more information. See the [express-graphql][] documentation for more information.
@ -94,7 +96,8 @@ The `graphbrainz` middleware function accepts the following options:
* **`PORT`**: Port number to use, if running the standalone server. * **`PORT`**: Port number to use, if running the standalone server.
When running the standalone server, [dotenv][] is used to load these variables When running the standalone server, [dotenv][] is used to load these variables
from a `.env` file, if one exists in the current working directory. See the from a `.env` file, if one exists in the current working directory. This just
makes it more convenient to launch the server with certain settings. See the
[dotenv][] package for more information. [dotenv][] package for more information.
### Debugging ### Debugging