search

codeforamerica / open311_java

Java language binding (wrapper) to the Open311 REST API
BSD 3-Clause "New" or "Revised" License
12 stars 5 forks source link

Link to deep parts of Maven-generated site from README.md #12

Closed ycombinator closed 11 years ago

ycombinator commented 11 years ago

The README.md in the root directory is the starting point of documentation when a user visits this GitHub repo. As such it should contain enough information to get the user started with the library as fast as possible but also contain links to important-but-not-immediately-useful information (like build status, code coverage, Javadocs, etc.).

A lot of this information is already contained in the Maven-generated site (located at http://codeforamerica.github.io/open311_java). Please link to these pieces information from the README.md.

SantiMunin commented 11 years ago

Done e8242d6b6c29a22a021d0c484a9bb50af077a499 and f547796ab773e603cc3556c48661083d9d118990