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

Update docs

Browse source
This commit is contained in:
Brian Beck 2016-11-28 19:33:52 -08:00
parent a249602cf3
commit 53e75c3611
4 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,14 +1,15 @@
<center>
# graphbrainz # graphbrainz
An [Express][] server and middleware for querying [MusicBrainz][] using An [Express][] server and middleware for querying [MusicBrainz][] using
[GraphQL][]. [GraphQL][].
```sh `npm install graphbrainz --save`
npm install graphbrainz --save
```
**[Try out the live demo!][demo]** Use the “Docs” sidebar or see the [schema][] **[Try out the live demo!][demo]**
to help construct your query.
Use the “Docs” sidebar, the [schema][], or the [types][] docs to help construct your query.
</center>
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@ -283,7 +284,7 @@ agree, it’s ugly.
## Schema ## Schema
See the [GraphQL schema][schema] or the [rendered documentation][types]. See the [GraphQL schema][schema] or the [types][] documentation.
[demo]: https://graphbrainz.herokuapp.com/ [demo]: https://graphbrainz.herokuapp.com/
[Express]: http://expressjs.com/ [Express]: http://expressjs.com/
@ -294,5 +295,5 @@ See the [GraphQL schema][schema] or the [rendered documentation][types].
[debug]: https://www.npmjs.com/package/debug [debug]: https://www.npmjs.com/package/debug
[GraphiQL]: https://github.com/graphql/graphiql [GraphiQL]: https://github.com/graphql/graphiql
[Relay]: https://facebook.github.io/relay/ [Relay]: https://facebook.github.io/relay/
[schema]: doc/schema.md [schema]: docs/schema.md
[types]: doc/types.md [types]: docs/types.md

0
doc/schema.md → docs/schema.md
View file

0
doc/types.md → docs/types.md
View file

4
package.json
View file

@ -19,8 +19,8 @@
"build": "npm run build:lib && npm run update-schema && npm run build:docs", "build": "npm run build:lib && npm run update-schema && npm run build:docs",
"build:docs": "npm run build:docs:readme && npm run build:docs:schema && npm run build:docs:types", "build:docs": "npm run build:docs:readme && npm run build:docs:schema && npm run build:docs:types",
"build:docs:readme": "doctoc --title \"## Contents\" README.md", "build:docs:readme": "doctoc --title \"## Contents\" README.md",
"build:docs:schema": "printf '# GraphQL Schema\\n\\n%s' \"$(npm run -s print-schema:md)\" > doc/schema.md", "build:docs:schema": "printf '# GraphQL Schema\\n\\n%s' \"$(npm run -s print-schema:md)\" > docs/schema.md",
"build:docs:types": "babel-node scripts/render-types.js > doc/types.md", "build:docs:types": "babel-node scripts/render-types.js > docs/types.md",
"build:lib": "babel --out-dir lib src", "build:lib": "babel --out-dir lib src",
"clean": "npm run clean:lib", "clean": "npm run clean:lib",
"clean:lib": "rm -rf lib", "clean:lib": "rm -rf lib",