Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs #1

Open
joestrong opened this issue Oct 11, 2017 · 4 comments
Open

Generate docs #1

joestrong opened this issue Oct 11, 2017 · 4 comments

Comments

@joestrong
Copy link
Owner

joestrong commented Oct 11, 2017

It would be nice to create some docs for interacting with this library

It would be nice to use https://apiblueprint.org format

@larizzatg
Copy link

I will like to work on this!

@joestrong
Copy link
Owner Author

@skayablars Yeah sure! You OK using the api blueprint format?

@larizzatg
Copy link

larizzatg commented Oct 13, 2017

@joestrong I'm okey with it but while reading the package and the retroachievements.org api I was unable to find a user and api key to test the response and create better documentation (I understand that the documentation is for your wrapper) can you provide them or tell me how to get them?

@joestrong
Copy link
Owner Author

If you sign up at http://retroachievements.org use your username and the api key on the settings page (http://retroachievements.org/controlpanel.php)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants