search

amadornes / MCMultiPart

A universal multipart API for Modern Minecraft
Other
67 stars 23 forks source link

Documentation? #61

Open Baughn opened 7 years ago

Baughn commented 7 years ago

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 commented 7 years ago

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 commented 7 years ago

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