drawcall / Proton

Javascript particle animation library
https://drawcall.github.io/Proton/
MIT License
2.42k stars 275 forks source link

added documentation #38

Closed JPeer264 closed 8 years ago

JPeer264 commented 8 years ago

Hey,

I updated some documentation. I hope it is ok for you if I merge more often, just in case you want to add something and we maybe got some merge conflicts ;)

I will do an overview of different options of Proton, such as behaviours, emitters, renderers and so on, at the Home page. Because it is really hard to get an overview just with the classnames and this will clarify if, e.g. Proton.Force is a behaviour or something else.

Maybe you can go through some files, such as Proton.Pool and can write some description for those things. Sometimes I was not pretty sure about it.

Regards Jan

drawcall commented 8 years ago

I need some time to examine the code structure. Thanks for the great work

JPeer264 commented 8 years ago

Sure, take the time you need ;)