aboutsummaryrefslogtreecommitdiffhomepage
path: root/letitsnow
diff options
context:
space:
mode:
Diffstat (limited to 'letitsnow')
-rw-r--r--letitsnow/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/letitsnow/README.md b/letitsnow/README.md
new file mode 100644
index 0000000..ec280d8
--- /dev/null
+++ b/letitsnow/README.md
@@ -0,0 +1,18 @@
+# Let It Snow #
+
+It is presicely what you imagine.
+
+To start the animation, just call this function, and (optionally) pass some options to it to configure the animation to your liking. For it to work you should have a canvas object in your document with id #snow.
+
+```javascript
+letItSnow({
+ 'max_particles': 200,
+ 'base_speed': 200,
+ 'max_xspeed': 300,
+ 'max_tradius': 20,
+ 'max_tduration': 5000,
+ 'interactive': true,
+});
+```
+
+Happy holidays 2018 and happy 2019!