From 2bd37c53bf18bc254184f6f17461ec9065c7ae6a Mon Sep 17 00:00:00 2001 From: Dessalines Date: Tue, 12 Feb 2019 16:39:31 -0800 Subject: [PATCH] Add API to Readme. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) 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