diff --git a/README.md b/README.md index 779da00..b34058c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 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: @@ -13,13 +13,18 @@ Maven users can add the following dependency to their pom.xml: fr.dudie nominatim-api - 3.3.1 + 3.4 *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 -------------- @@ -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). diff --git a/release.sh b/release.sh index 81e2492..cf77144 100755 --- a/release.sh +++ b/release.sh @@ -47,7 +47,7 @@ git clone git@github.com: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