search

ToothlessGear / node-gcm

A NodeJS wrapper library port to send data to Android devices via Google Cloud Messaging
https://github.com/ToothlessGear/node-gcm
Other
1.31k stars 206 forks source link

Full API documentation #98

Closed hypesystem closed 9 years ago

hypesystem commented 9 years ago

An interface-by-interface documentation of how to use the code would be most useful.

dhcar commented 9 years ago

+1. The gcm message keys have me confused.

hypesystem commented 9 years ago

Many of the keys are the exact equivalents of the ones specified by GCM. They are most likely explained in the GCM HTTP documentation. Of course, they should be mentioned in the API documentation, too.

hypesystem commented 9 years ago

Docco could be used for this purpose. I think jasmine does this to great effect.

ToothlessGear commented 9 years ago

:+1:

hypesystem commented 9 years ago

Fixed in #111