Skip to content

Commit f06bdf2

Browse files
committed
Prepare for 0.2.0 release
1 parent 760058d commit f06bdf2

2 files changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ schemas. It aims to provide a better overview of a schema than
1313

1414
## Installation and usage
1515

16-
GraphQL-Docs tries to work similarly to GraphiQL in most areas. Either use the
17-
minified files from GitHub:
16+
GraphQL-Docs supports both a dynamic mode and a static mode. In dynamic mode,
17+
GraphQL-Docs tries to work similarly to GraphiQL. Either use the minified files
18+
from GitHub:
1819

1920
```html
20-
<script src="https://github.com/mhallin/graphql-docs/releases/download/v0.1.4/graphql-docs.min.js"></script>
21+
<script src="https://github.com/mhallin/graphql-docs/releases/download/v0.2.0/graphql-docs.min.js"></script>
2122
<!-- Note that you need to include React and ReactDOM *before* this script tag -->
2223
```
2324

@@ -53,6 +54,17 @@ All CSS is included in the Javascript code, so no other dependencies are
5354
required. You can find examples of both the first and second paradigms in the
5455
examples folder.
5556

57+
## Static documentation generation
58+
59+
You can also generate a static documentation file based on a schema file or
60+
GraphQL endpoint:
61+
62+
```sh
63+
npm install -g graphql-docs
64+
65+
graphql-docs-gen http://GRAPHQL_ENDPOINT documentation.html
66+
```
67+
5668
## Features
5769

5870
* Markdown rendered documentation (using

example/standalone.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.0.2/react.js"></script>
1111
<script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.0.2/react-dom.js"></script>
1212
<script src="https://cdnjs.cloudflare.com/ajax/libs/fetch/1.0.0/fetch.min.js"></script>
13-
<script src="https://github.com/mhallin/graphql-docs/releases/download/v0.1.4/graphql-docs.min.js"></script>
13+
<script src="https://github.com/mhallin/graphql-docs/releases/download/v0.2.0/graphql-docs.min.js"></script>
1414
<script>
1515

1616
function fetcher(query) {

0 commit comments

Comments
 (0)