From 9427fbd726746a840cf412174c813810742920d4 Mon Sep 17 00:00:00 2001 From: Yaroslav Date: Thu, 13 Dec 2018 20:06:28 +0300 Subject: explain let it snow options --- letitsnow/README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/letitsnow/README.md b/letitsnow/README.md index ec280d8..93acf84 100644 --- a/letitsnow/README.md +++ b/letitsnow/README.md @@ -6,13 +6,22 @@ To start the animation, just call this function, and (optionally) pass some opti ```javascript letItSnow({ - 'max_particles': 200, - 'base_speed': 200, - 'max_xspeed': 300, - 'max_tradius': 20, + 'max_particles': 400, + 'base_speed': 100, + 'max_xspeed': 150, + 'max_tradius': 10, 'max_tduration': 5000, 'interactive': true, }); ``` +### What does each option mean ### + +* max_particles: The amount of snowflakes drawn onscreen +* base_speed: The base speed at which snowflakes should fall (pixels per second) +* max_xspeed: Maximum speed of "wind" or horizontal speed of flakes (also pix/s) +* max_tradius: How much should be the maximum that the snowflakes should swing from left to right (or turbulence). +* max_tduration: How fast each snowflake should swing (milliseconds) +* interactive: Should the position of the mouse affect the wind + Happy holidays 2018 and happy 2019! -- cgit v1.2.3