search

slightlyoff / cassowary.js

Cassowary/JS, better, faster, future-ready
Other
1.69k stars 107 forks source link

Documentation #73

Open raineorshine opened 8 years ago

raineorshine commented 8 years ago

Is there documentation or a list of API methods somewhere? I'm not sure how to get started. The Getting started under Node section of the README hints at how to use this library, but it does not give a full example or list the available methods.

epsxy commented 8 years ago

Hi, I'm also concerned about the lack of documentation here. However, if you want an introduction to basic features, the documentation for the python API provides a good start to the basic methods of cassowary. You just have to adapt the name of methods and the utilisation is quite the same. I'm currently working on all this stuff and I will probably write some kind of documentation for my own use of cassowary.js, maybe it'll be useful for other people over here.