diff --git a/README.md b/README.md index 2c971f7..e47d353 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ # Dash-html-ticker -## A small copy-and-paste HTML Dash price widget +### A small copy-and-paste HTML Dash price widget -This is a small self-contained Dash price widget. It uses the coinmarketcap.com API at https://coinmarketcap-nexuist.rhcloud.com/ to retrieve the price of Dash and display it on a webpage. \ No newline at end of file +This is a small self-contained Dash price widget. It uses the coinmarketcap.com API at https://coinmarketcap-nexuist.rhcloud.com/ to retrieve the price of Dash and display it on a webpage. + +## Demo + +You can see a demo of this project at http://seigler.github.io/Dash-html-ticker. + +## Using This Project + +Copy the contents of /dist/index.html and add them anywhere you can put raw HTML. + +## Building This Project + +This project assembles the markup, styles, images, and scripts with an [npm](https://howtonode.org/introduction-to-npm) script. To build the project, run "npm run test". \ No newline at end of file