X-Git-Url: https://git.r.bdr.sh/rbdr/heart/blobdiff_plain/aef6eff607f97150506522b8f8df89ac1ab2f72c..910278aad4a0b47dc40112839a18bc8e590302e5:/README.md

diff --git a/README.md b/README.md
index e55907e..6238f46 100644
--- 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`