mascot-vis 1.12.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,4 +8,9 @@
8
8
  ## Build and Run Project
9
9
 
10
10
  1. To build project one time with `npm run build` OR build automatically on save with file watching `npm run watch`
11
- 2. Start a server with `npm run start` (you need to have Python 3 installed), and load `localhost:8020` in browser; you can also start the server using Python 2 with commands like `python -m SimpleHTTPServer <port>`
11
+ 2. Start a server with `npm run start` (you need to have Python 3 installed), and load `localhost:8020` in browser; you can also start the server using Python 2 with commands like `python -m SimpleHTTPServer <port>`
12
+
13
+ ## Add a Demo to the Gallery
14
+ 1. Add a new .js file with a descriptive name containing the demo code to the `demos` folder. If you require sample code, refer to the other demos available in that folder.
15
+ 2. Any dataset used in your demo should be placed in the corresponding folder in `datasets`.
16
+ 3. Add a new entry to `_index.json` in the `demos` folder, your key must have the initial letter capitalized and match the name of your .js file.