Update readme and build script

2018-02-02 10:48:48 +00:00
parent 2f8b6cfdec
commit dd0456cd2b
2 changed files with 18 additions and 5 deletions
--- a/README.md
+++ b/README.md
@@ -38,6 +38,21 @@ var simulation = d3.forceSimulation(nodes);
 </script>
 ```

+## File structure
+- [index.js](index.js) Export list of the module
+- [src/](src) Source code of the module
+- [package.json](package.json) Node.js moudle descriptor with build scripts
+- [img](img) Images for this readme file
+- [examples](examples) An example page running all the algorithms implemented
+
+## Building
+```bash
+npm run build
+npm run minify
+npm run zip
+```
+See package.json for more details.
+
 ## API Reference

 #### Spring Model