initial commit

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8a6bf59
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+bluerose
+========
+
+an interactive map-creation tool
+
+
+running
+-------
+
+bluerose is a standalone webapp written in vanilla js; as such, you should be able to just open `index.html` in a web browser and use it.
+
+To run the tests:
+
+```
+npm
+npm test
+```
+
+
+credits
+-------
+
+bluerose was written by me! (sanine)
+
+I've used [gorhill's Javascript-Voronoi] algorithm in performing terrain generation.
+
+The terrain and mapping algorithms were very heavily inspired by mewo2's Uncharted Atlas, which has an [excellent explanatory page].
+
+
+[gorhill's Javascript-Voronoi`]: https://github.com/gorhill/Javascript-Voronoi/
+[excellent explanatory page]: https://mewo2.com/notes/terrain/