chore: added README to example directory (#865)

* Added README to example directory to help bring clarity to developers new to the platform that re testing functionality * updated from port 3000 to 30000 in docs, and added small editorial fixes for clarity
3box · Jul 17, 2020 · 3efecf7 · 3efecf7
1 parent 4ba3c3b
commit 3efecf7
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,10 @@
+## <a name="example"></a> Example Application
+
+You can quickly run and interact with the example code in this directory. You run the example with the following commands:
+
+```bash
+$ npm ci
+$ npm run example:start
+```
+
+This runs a simple server at `http://localhost:30000/` that serves the static `example/index.html` file. This allows it easily interact with Metamask. You can edit the `example/index.html` file to try different code.