LBRYCommunity/lighthouse.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added two simple examples to README.

Browse source 
Added two small examples for search and autocomplete so people can try it out without digging into the API doc.
This commit is contained in:
filipnyquist 2019-02-05 11:10:25 +01:00 committed by GitHub
parent 1e39ffc61a
commit da02023c7a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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