search

samccone / monocle

a tool for watching things
MIT License
17 stars 12 forks source link

Improve documentation #4

Closed ForbesLindesay closed 11 years ago

ForbesLindesay commented 11 years ago

It's not clear for the odcs exactly what the API is. Looking at the source, there's no need to call it with new. Also, each method seems to just take a single args argument, not multiple arguments as the readme implies.

It's not clear what the purpose of having an instance of a monocle is rather than just making the two methods directly attach to exports. Why would I want multiple separate monocles?

It should specify exactly what internal API is used on what platform somewhere in the readme.

samccone commented 11 years ago

:thumbsup: will fix this

ForbesLindesay commented 11 years ago

cool, just don't want jade to depend on it till this stuff is taken care of.

samccone commented 11 years ago

updated :)

@forbesLindesay