Details
-
Type:
Task
-
Status: Open
-
Priority:
Major
-
Resolution: Unresolved
-
Affects Version/s: 0.2
-
Fix Version/s: None
-
Component/s: Docs
-
Labels:None
Description
We should add some documentation about the Java API to the top-level README. It should include info about how to get the artifacts (which haven't been published yet), and some examples of how to use the code.
We also should look at how to generate and publish javadocs; not sure whether it's possible to publish them through github somehow.