From 53e75c36113ffc077491c0caebb2ad8b711c5abe Mon Sep 17 00:00:00 2001 From: Brian Beck Date: Mon, 28 Nov 2016 19:33:52 -0800 Subject: [PATCH] Update docs --- README.md | 17 +++++++++-------- {doc => docs}/schema.md | 0 {doc => docs}/types.md | 0 package.json | 4 ++-- 4 files changed, 11 insertions(+), 10 deletions(-) rename {doc => docs}/schema.md (100%) rename {doc => docs}/types.md (100%) diff --git a/README.md b/README.md index 5f9ed8e..faf8914 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ +
# graphbrainz An [Express][] server and middleware for querying [MusicBrainz][] using [GraphQL][]. -```sh -npm install graphbrainz --save -``` +`npm install graphbrainz --save` -**[Try out the live demo!][demo]** Use the “Docs” sidebar or see the [schema][] -to help construct your query. +**[Try out the live demo!][demo]** + +Use the “Docs” sidebar, the [schema][], or the [types][] docs to help construct your query. +
@@ -283,7 +284,7 @@ agree, it’s ugly. ## 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/ [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 [GraphiQL]: https://github.com/graphql/graphiql [Relay]: https://facebook.github.io/relay/ -[schema]: doc/schema.md -[types]: doc/types.md +[schema]: docs/schema.md +[types]: docs/types.md diff --git a/doc/schema.md b/docs/schema.md similarity index 100% rename from doc/schema.md rename to docs/schema.md diff --git a/doc/types.md b/docs/types.md similarity index 100% rename from doc/types.md rename to docs/types.md diff --git a/package.json b/package.json index a8f86a3..6fad4e1 100644 --- a/package.json +++ b/package.json @@ -19,8 +19,8 @@ "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: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:types": "babel-node scripts/render-types.js > doc/types.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 > docs/types.md", "build:lib": "babel --out-dir lib src", "clean": "npm run clean:lib", "clean:lib": "rm -rf lib",