diff --git a/README.md b/README.md index 1bb1897..80c1a43 100644 --- 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