diff --git a/README.md b/README.md index f58735b..1230bda 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,10 @@ This simple project uses the Insight API and Web Sockets to stream transactions [See it in action!](https://seigler.github.io/dash-visualizer) -## Installation -Download the project. No build step is necessary. +## Development +`npm install` or `yarn` -## Usage -Open `index.html`. \ No newline at end of file +**Commands: (`npm run ` or `yarn `)** +* `build` - Build the site to the `public` directory +* `watch` - Build the site, watch for changes, and serve it at http://localhost:3333/ +* `deploy` - Build the site to the `public` directory, then push that directory to the Github Pages branch