Add API to Readme.

2019-02-12 16:39:31 -08:00 · 2019-02-12 16:39:31 -08:00 · 2bd37c53bf
commit 2bd37c53bf
parent cf037c58e0
1 changed files with 6 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -111,6 +111,12 @@ cd torrents.csv/scripts
 ./update.sh SAVE_TORRENT_DIR
 ```

+## API
+
+A JSON output of search results is available at:
+
+http://localhost:8080/service/search?q=[QUERY]&size=[NUMBER_OF_RESULTS]&offset=[PAGE]
+
 ## How the torrents.csv file looks

 ```sh