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

Documentation? #61

Open
Baughn opened this issue Nov 14, 2016 · 2 comments
Open

Documentation? #61

Baughn opened this issue Nov 14, 2016 · 2 comments

Comments

@Baughn
Copy link

Baughn commented Nov 14, 2016

It would be great to have API documentation.

If that already exists, and I haven't found it, then consider this a request to add it to README.md. Otherwise... well, I don't expect it'd be quick to write, but it'd help adoption.

@amadornes
Copy link
Owner

There are javadocs on all the major classes you'll be working with if you support MCMP, but I do agree that there should be something in the wiki about it. I've been saying I'll do it at some point for a while and I think I'll end up doing it when 2.0.0 is ready to be released. Until then, you know where to find me. I'm always here to help :)

@Baughn
Copy link
Author

Baughn commented Nov 14, 2016

Just don't forget to add pointers to the readme!

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