Add basic animator project

[rbdr/heart] / README.md

diff --git a/README.md b/README.md
index e55907e63d303a171deee374277eff928da8a08f..6238f4662597d9834aa70f4412e61930a625300a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-# heart
-The heart
+# Heart
+
+Renders a colorful heart
+
+## How to run
+
+Serve the files in the root directory. For example using: `python -m SimpleHTTPServer`
+
+## Setting up
+
+Though this project is mostly static you should run `yarn install` or
+`npm install` so you can lint and document the project.
+
+## Generating documentation
+
+1. Run `npm run document`.
+2. Serve the files that have been generated in the `doc` directory. If
+   already serving the files, just go to `/doc`
+
+## Linting
+
+1. Run `npm lint`