docs for gh-pages

dockwa · Nov 14, 2018 · f1a06d6 · f1a06d6
1 parent aa769ab
commit f1a06d6
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,7 +6,7 @@ Yay, you're interested in helping work on this project.  Thank you!
 
   - `src/`      - JavaScript Source
   - `dist/`     - Compiled and Minified
-  - `examples/` - Example test cases in browser
+  - `docs/`     - Example test cases in browser and publishes to GitHub Pages
 
 ## Having a problem?
 

diff --git a/example/example.jsx → docs/example.jsx b/example/example.jsx → docs/example.jsx
diff --git a/example/index.html → docs/index.html b/example/index.html → docs/index.html
@@ -21,7 +21,7 @@
   <body>
     <div id="root">
       <div class="text-center mt-4">
-        open terminal, run <code>npm run serve</code> in the project directory, and navigate to <a href="http://localhost:3000/example">localhost:3000/example</a>
+        open terminal, run <code>npm run serve</code> in the project directory, and navigate to <a href="http://localhost:3000/docs">localhost:3000/docs</a>
     </div>
   </body>
 </html>