Need for better/any documentation

[karanjassar]

Seems like a great library but it would help if there were even minimal documentation for various options possible and the differences.

The code is clean and easy to read but still needs some knowledge of color theory to get started. It'll also enable others to make enhancements and send pull requests for minor changes.

Please consider starting a wiki with minimal info and I'm sure others chime in to improve it over time.

[richardj]

There is documentation / how to use on the website: http://www.checkman.io/please/

[Fooidge]

He makes a fair point, I'll add the doc to the repository.

[richardj]

Sorry to open this again, but maybe instead of having the documentation in a separate text document you can add it to the README.md? This adds the value of being instantly visible when you visit the repository and having markup (also one less document that clutters your repository).

[karanjassar]

I missed the docs the first time I saw the website. For now, it's ok if we can add a link to the text file (http://www.checkman.io/please/Please_docs.txt) in the read me.

[Fooidge]

I'll totally add it to the README eventually, its just kind of a task to format it since I haven't jumped into markdown for awhile. Fear not.

[Xananax]

I just quickly patched together the doc from your text file
It's here:
https://github.com/Synclop/PleaseJS

If you think it's cool I can submit a pull request.

[Fooidge]

With minor revisions it turned out great! Thanks all.