Add docs for suggestedEdits

readmeio · Dec 5, 2017 · 0042179 · 0042179
1 parent 4a6c3c0
commit 0042179
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/api-explorer-ui/README.md b/packages/api-explorer-ui/README.md
@@ -19,6 +19,7 @@ npm install --save api-explorer-ui
   oasFiles={Object}
   flags={Object}
   oauthUrl={String}
+  suggestedEdits={Boolean}
 />
 ```
 
@@ -33,6 +34,7 @@ npm install --save api-explorer-ui
 
 - `flags` -  an object of project flags from readme. Changing these will modify how the API Explorer works.
 - `oauthUrl` - a URL containing the oauth login endpoint
+- `suggestedEdits` - whether suggested edits are enabled or not. This just toggles the button.
 
 ## Credits
 [Dom Harrington](https://github.com/domharrington/)