README API documentation overhaul

[ncb000gt]

The API documentation hasn't changed much since I threw it together with the original module. Clearer documentation has always been a source of irritation for users.

[ncb000gt]

That would be great. Thanks!

[balajipachai]

One quick question: reworking the API documentation does it imply, changing it in the API section/ adding code examples in the README section?

[ncb000gt]

@balajipachai yes. Right now it's too condensed and kind of hard to read unless you know it well. The readme itself isn't broken out well.

An example of something I'm looking for is something like: https://github.com/RobinBuschmann/sequelize-typescript

[keplerk]

Indeed that would be nice, thumbs up for this

[nmay231]

Another thing that could be done is to host the example docs on something like github.io or gitbook (premium is free for open-source projects) and then get a domain from js.org. Both cron.js.org and node-cron.js.org are available.

Don't know if it's something you want to do for this project, but it's an idea. 🤷‍♂️

[ncb000gt]

This sounds like a great idea. :) - Nick Campbell

…

On Sat, Feb 1, 2020 at 1:14 AM Noah ***@***.***> wrote: Another thing that could be done is to host the example docs on something like github.io or gitbook (premium is free for open-source projects) and then get a domain from js.org <https://github.com/js-org/js.org>. Both cron.js.org and node-cron.js.org are available. Don't know if it's something you want to do for this project, but it's an idea. 🤷‍♂ — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#441?email_source=notifications&email_token=AAAPJF3NEYHI4KVHY6LVFHTRAUHM3A5CNFSM4I2SMD62YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKQVNVI#issuecomment-580998869>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPJF5B7QCZ3V7KKZABRY3RAUHM3ANCNFSM4I2SMD6Q> .

[sheerlox]

some good project READMEs to use as inspiration:

• axios/axios
• jestjs/jest
• sequelize/sequelize-typescript

cc @rharshit82

[ncb000gt]

🎉 This issue has been resolved in version 3.1.5 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀