Mention useful options for package.json config in Readme

2fd · Jan 25, 2020 · 71bbafe · 71bbafe
1 parent 2ddb37c
commit 71bbafe
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.handlebars b/README.handlebars
@@ -68,8 +68,12 @@ schema"](http://dev.apollodata.com/tools/graphql-tools/generate-schema.html#modu
 {
   "name": "project",
   "graphdoc": {
+    "title": "Graphdoc", // Custom title
     "endpoint": "http://localhost:8080/graphql",
+    "template": "./template/slds", // Path to your template
     "output": "./doc/schema",
+    "graphiql": "http://localhost:8080/graphql", // GraphiQL URL
+    "ga": "UA-XXXXXXXX-X", // Google Analytics UA Number
   }
 }
 ```

diff --git a/README.md b/README.md
@@ -68,8 +68,12 @@ schema"](http://dev.apollodata.com/tools/graphql-tools/generate-schema.html#modu
 {
   "name": "project",
   "graphdoc": {
+    "title": "Graphdoc", // Custom title
     "endpoint": "http://localhost:8080/graphql",
+    "template": "./template/slds", // Path to your template
     "output": "./doc/schema",
+    "graphiql": "http://localhost:8080/graphql", // GraphiQL URL
+    "ga": "UA-XXXXXXXX-X", // Google Analytics UA Number
   }
 }
 ```