Document API

Question

Document API

Widdershin opened this issue 8 years ago · 6 comments

Before we release v0.1 it would be great to add some documentation to the README around the various options that are currently available.

@schempy @apretto do either of you feel like taking a crack at this? I probably won't get to it this week (currently traveling, will only be home for a day before I have more traveling to do). I'm more than happy to help though.

I think this is the last thing we need to do before our first release.

Answer 1 · 2016-05-03T05:11:44.000Z

@Widdershin I'll take a crack at it!

Answer 2 · 2016-05-03T05:19:51.000Z

Awesome :)

Answer 3 · 2016-05-08T05:06:01.000Z

@Widdershin I added API documentation. Feel free to make changes and additions :)

Answer 4 · 2016-05-08T05:41:19.000Z

That is fantastic. Very detailed and thorough, you should be proud. How would you like to release the first version? I can help you get it published to npm

Answer 5 · 2016-05-08T06:48:11.000Z

Thanks! That would be awesome if I could release the first version. Any help would be great!

Answer 6 · 2016-05-09T06:17:33.000Z

@schempy I've opened #7 with a big checklist of stuff to do for the initial release! Hope that helps and everything is clear. Let me know if you run into any problems 😄