From 3efecf74c4eff6ed5aebb15a10c5550b8c61ce5e Mon Sep 17 00:00:00 2001
From: mikedeshazer <guyonaplane57@gmail.com>
Date: Fri, 17 Jul 2020 17:40:07 +0900
Subject: [PATCH] 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
---
 example/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 example/README.md

diff --git a/example/README.md b/example/README.md
new file mode 100644
index 00000000..ce2de230
--- /dev/null
+++ 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.