Merge pull request #26 from speckleworks/curve-domains

adds domains to all curve like entities - fixes #25
speckleworks · May 21, 2018 · 446087e · 446087e
2 parents 3f9e72f + 071530f
commit 446087e
Show file tree

Hide file tree

Showing 30 changed files with 8,324 additions and 41,252 deletions.
diff --git a/README.md b/README.md
@@ -4,15 +4,14 @@
 
 # Visualise & Edit
 
-Open the `SpeckleV1OpenApiSpecs.yaml` file in the [OpenApi editor](https://editor.swagger.io//#/).
+Open the `SpeckleV1OpenApiSpecs.yaml` file in the [OpenApi editor](https://editor.swagger.io//#/). You can then edit at your own ease, and suggest changes, etc.
 
-Documentation generated with shins and widdershins is also available [here](https://speckleworks.github.io/SpeckleSpecs/).
-
-# Generate clients
+# Build the docs
 
-Use the `generate client` option from the [OpenApi editor](https://editor.swagger.io//#/).
+To save time, please also follow these quick steps to build the documentation:
 
-# Build the docs
+1. `npm install`
+2. `npm run build-shins` - this will generate the docs (which are published via github from the `docs` folder.
+3. Commit and do a PR.
 
-1. Run `npm-install`
-2. Run `npm run build-shins`
+That's it!