Skip to content
This repository was archived by the owner on Aug 9, 2021. It is now read-only.

Commit 3efecf7

Browse files
authored
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
1 parent 4ba3c3b commit 3efecf7

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

example/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## <a name="example"></a> Example Application
2+
3+
You can quickly run and interact with the example code in this directory. You run the example with the following commands:
4+
5+
```bash
6+
$ npm ci
7+
$ npm run example:start
8+
```
9+
10+
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.

0 commit comments

Comments
 (0)