🔤 updated development instructions

This commit is contained in:
Joshua Seigler 2017-09-12 13:42:36 -04:00
parent 43f98d98fc
commit a6b12f40a2

View file

@ -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`.
**Commands: (`npm run <command>` or `yarn <command>`)**
* `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