Skip to content

Commit

Permalink
Change README.md; Update submodule wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
Maingron committed Oct 25, 2020
1 parent dc039b6 commit 0baa439
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 25 deletions.
42 changes: 18 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,37 @@
# Snow.js

**Snow.js** spawns snow over your website. Updates will follow.<br>
Development started on <time>2019/11/05</time>.


To implement Snow.js onto a website, go to the end of your HTML and include it via a \<script\>-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 <time>2019-11-05</time>.



## Installing
To implement Snow.js onto a website, go to the end of your HTML and include it via a \<script\>-tag.

Recommended code to implement snow.js:
```html
<script src="snow.js" async charset="UTF-8"></script>
```


Make sure to copy snow.js into your website directory and check, if the link is right.<br>
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

<br>

## 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)

<br>
## 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 <br>
Github Site: https://maingron.com/github/snowjs

Project Website: https://maingron.com/snowjs
Github Site: https://maingron.com/github/snowjs
2 changes: 1 addition & 1 deletion wiki
Submodule wiki updated from a1b975 to cf7567

0 comments on commit 0baa439

Please sign in to comment.