Let me preface this by saying that I love coding -- it's enjoyable and a lot of fun to write a couple hundred lines of code and have it run for months just doing its thing. As a developer, I don't really enjoy writing documentation which is a flaw I'm addressing. Part of the joy of programming is that you can get rewarded instantly after spending a day writing code. If I spend a day writing documentation, I don't immediately get that sense of satisfaction.

The problem with this is that writing documentation is a long-term investment that addresses countless e-mails the developer will get from people asking "How does this work? What does this parameter do? Have you listed all the endpoints or are there some undocumented ones?" Well, if there isn't any documentation, basically every endpoint is an undocumented one. :)

Over the next month, I'm going to address this by taking a day out of each week and just making it "documentation day." After a few days, the documentation should be pretty substantial and give a lot more information for other developers to use so that they can write code and get that sense of satisfaction instead of a sense of frustration from having to learn how the API works by trial and error.

I have looked at various options, and I think using the Swagger format is ideal for this project. Basically, it's one huge YAML file that will document all endpoints and parameters. The nice thing about using this is that it is compatible with sites like readme.io -- plus it allows for auto-generation of curl examples, etc.

I've written to the readme.io team to ask for a free plan (the lowest plan is $100 a month but they give free plans to open source projects). One the documentation goes public, I'll post a link and invite everyone to take a look and make suggestions, etc.

Thank you!