From da02023c7a8b0a9fb8ffe3f0f1b5ae981092fdae Mon Sep 17 00:00:00 2001 From: filipnyquist Date: Tue, 5 Feb 2019 11:10:25 +0100 Subject: [PATCH 1/2] Added two simple examples to README. Added two small examples for search and autocomplete so people can try it out without digging into the API doc. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a72821..5fc0133 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,15 @@ The official lighthouse instance is live at https://lighthouse.lbry.io 1. Elasticsearch as a backend db server. 2. LBRYimport, an importer that imports the claims into the Elasticsearch database. 3. Lighthouse API server, which serves the API and does all calculations about what to send to the end user. -### API Documentation - +### API Documentation / Usage example +To make a simple search by string: +``` +https://lighthouse.lbry.io/search?s=stringtosearch +``` +To get autocomplete suggestions: +``` +https://lighthouse.lbry.io/autocomplete?s=stringtocomp +``` [The full API documentation](https://lbryio.github.io/lighthouse/) ## Installation From c870f05faa6ca4278c96930bcc661088cd667c0a Mon Sep 17 00:00:00 2001 From: filipnyquist Date: Tue, 5 Feb 2019 11:12:37 +0100 Subject: [PATCH 2/2] Removed old information from README We are not using the python decoder anymore as we are using chainquery nowadays. --- README.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/README.md b/README.md index 5fc0133..b153060 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,6 @@ https://lighthouse.lbry.io/autocomplete?s=stringtocomp ### Prerequisites * [Node v8](https://nodejs.org/en/download/) * [Yarn](https://yarnpkg.com/en/docs/install) -* [Python 2.7](https://www.python.org/downloads/) * [Elasticsearch](https://www.elastic.co/downloads/elasticsearch) @@ -34,11 +33,6 @@ https://lighthouse.lbry.io/autocomplete?s=stringtocomp ``` git clone https://github.com/lbryio/lighthouse ``` ->Grab the latest release of lbrycrd here: - -[Download lbrycrd](https://github.com/lbryio/lbrycrd/releases) ->Create a lbrycrd config file at ~/.lbrycrd/lbrycrd.conf which contains rpcuser,rpcpassword and rpcport. Then run lbrycrd in the background with that config file. - >Make sure elasticsearch is running and run (from the lighthouse dir): ``` ./gendb.sh @@ -47,10 +41,6 @@ git clone https://github.com/lbryio/lighthouse ``` yarn install --production=false ``` ->Start an instance of the decoder: -``` -cd decoder && pip install -r requirements.txt && python decoder.py -``` >Build and run Lighthouse: ``` yarn run prod