Add documentation

[tursics]

Write a documentation for

• meta tags
• library interface
• general information

[gazconroy]

Hi Thomas

I'm a technical writer with a good few years under my belt but learning the API documentation 'ropes' at the moment and want to get some real-world examples in my portfolio. Does this use a RESTful API? If so, I might be able to help.

I would need to know a few things to get started (or pointers on where to look):

• Authentication method such as an API key
• Base path for the API
• List of all endpoints
• List of all methods for each endpoint
• List of all parameters for each endpoint
• Responses for each method.

Let me know if you are interested.

[tursics]

Hi @gazconroy

Thanks for comment this issue and thanks for your interest. To make it clear: this library has no RESTful API. I will change the bullet point in the issue description. I didn't mean an API endpoint, I mean a library interface