diff --git a/README.md b/README.md index 3687957..8c7cc83 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,37 @@ # Snow.js -**Snow.js** spawns snow over your website. Updates will follow.
-Development started on . -To implement Snow.js onto a website, go to the end of your HTML and include it via a \-tag. +## Table of contents +- [About snow.js](#about-snowjs) +- [Installing](#installing) +- [Documentation](#documentation) + + +## About snow.js +**Snow.js** spawns snow❄ over your website. You could also use it for Halloween and spawn pumpkins🎃. Updates will follow. +Development started on . + + +## Installing +To implement Snow.js onto a website, go to the end of your HTML and include it via a \-tag. Recommended code to implement snow.js: ```html ``` - -Make sure to copy snow.js into your website directory and check, if the link is right.
+Make sure to copy snow.js into your website directory and check, if the link is right. If you want to modify the snow, you can do that by modifying the config section in snow.js -
-## Configuration options: -`snowChars`: Defines the characters used as snow -`tickTime`: Defines the time between frames in milliseconds -`maxSnow`: Defines the amount of snowflakes spawned -`jitterAmount`: Defines how jittery the snowflakes are -`gravityAmount`: Defines how fast the snowflakes fall down -`initialYDistance`: Defines how far apart the snowflakes are spawned initially -`snowSizes`: Defines the sizes of the snowflakes -`snowColors`: Defines the colors of the snowflakes -`snowFont`: Defines the font of the snowflakes (css) -
+## Documentation +You can find the documentation on https://github.com/Maingron/snow.js/wiki -## To-do List: -- [ ] Use Images as snow --- - - -Project Website: https://maingron.com/snowjs
-Github Site: https://maingron.com/github/snowjs - +Project Website: https://maingron.com/snowjs +Github Site: https://maingron.com/github/snowjs \ No newline at end of file diff --git a/wiki b/wiki index a1b9756..cf75677 160000 --- a/wiki +++ b/wiki @@ -1 +1 @@ -Subproject commit a1b9756982e859a6982419815e05d5d8ea12d81b +Subproject commit cf7567745b3fa0156128619a169df88e3df3af1d