kriskowal / q

A promise library for JavaScript
MIT License
14.95k stars 1.2k forks source link

Create a "cheat sheet" #294

Open domenic opened 11 years ago

domenic commented 11 years ago

Instead of the long-winded API docs, something with the brevity of the JSDocs already in the source code.

fresheneesz commented 10 years ago

I think I second this. The reference is very good. The readme here is less so. The reference needs a link at the top of the page, and most of the tutorial stuff should be split off into a separate page as well (like on the wiki). The readme should contain some starter information - enough to be able to easily understand the reference. Everything else needs to go somewhere else.

lfac-pt commented 10 years ago

A link at the top of readme to the reference would be very good indeed (and convenient for me).

kriskowal commented 10 years ago

Assigning to @domenic, praying he has an idle moment. Of course, this is a great task for a member of the community looking to provide a high impact contribution without too much hassle.