Skip to content
This repository has been archived by the owner on Nov 29, 2024. It is now read-only.

Commit

Permalink
Update readme with a link to API javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremiehuchet committed Jun 19, 2019
1 parent 4fbbb33 commit b9212fa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,26 @@ Nominatim Java API

This library provides a client for [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim). This API provides search and reverse geocoding operations.

How to use
Quickstart
----------

Maven users can add the following dependency to their pom.xml:

<dependency>
<groupId>fr.dudie</groupId>
<artifactId>nominatim-api</artifactId>
<version>3.3.1</version>
<version>3.4</version>
</dependency>

*Note that it is fair and reasonable to specify an email address when using the Nominatim API*, see the [Notminatim Usage Policy](https://operations.osmfoundation.org/policies/nominatim/) for more informations.

> If you are sending in large numbers of requests it is particularly important that we have some way of contacting you - otherwise, in the event of problems, the only alternative is to ban your IP and wait for you to contact us.
How to use
----------

See the API [javadoc](https://jeremiehuchet.github.io/nominatim-java-api/latest).

Java & Android
--------------

Expand All @@ -28,6 +33,6 @@ I don't use it anymore in android app but it should still be compatible with And
Features
--------

See the [releases](https://github.com/kops/nominatim-java-api/releases) page.
See the [releases](https://github.com/jeremiehuchet/nominatim-java-api/releases) page.

Please ask for enhancements and report bugs on [Github tracker](https://github.com/kops/nominatim-java-api/issues/new) or [contact us](http://www.google.com/recaptcha/mailhide/d?k=01Th60_7w3rxWuSJumsnqxfg==&c=REgbsYXndhO58POROxZGybu0F_Xu3JmR-wBRNbh8knE).
Please ask for enhancements and report bugs on [Github tracker](https://github.com/jeremiehuchet/nominatim-java-api/issues/new) or [contact us](http://www.google.com/recaptcha/mailhide/d?k=01Th60_7w3rxWuSJumsnqxfg==&c=REgbsYXndhO58POROxZGybu0F_Xu3JmR-wBRNbh8knE).
2 changes: 1 addition & 1 deletion release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ git clone [email protected]:jeremiehuchet/nominatim-java-api.git ${basedir}/target/
cd ..
rm -f latest
ln -s ${VERSION} latest
find -mindepth 1 -maxdepth 1 -type d ! -name '.*' -printf '%P\n' > index.txt
find -mindepth 1 -maxdepth 1 ! -type f ! -name '.*' -printf '%P\n' | sort > index.txt
git add .
git commit -m "update javadoc with ${VERSION}"
git push origin gh-pages
Expand Down

0 comments on commit b9212fa

Please sign in to comment.