feedhenry / fh-sync

Node.js implementation of the FeedHenry Data Synchronisation Server. To be used in conjunction with the FeedHenry Data Synchronisation Client.
http://feedhenry.org
Apache License 2.0
5 stars 17 forks source link

Improve README #4

Closed wtrocki closed 7 years ago

wtrocki commented 7 years ago

Improve README to provide some basic documentation for module

aidenkeating commented 7 years ago

@wtrocki In terms of what is already available we have a couple of places that a lot of documentation could be sourced from.

Also. either using the already existing JSDoc in new sync or the upcoming declaration file we can generate automated docs for sync (using typedoc in TypeScripts case).