evan/rats-search
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added API documentation (basic)

Browse Source
This commit is contained in:
Alexey Kasyanchuk
2023-06-06 16:43:58 +03:00
parent 03f0ab7a47
commit ff1c8fd8e9
2 changed files with 76 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -30,7 +30,7 @@ BitTorrent search program for desktop and web. Collect and navigate over base of
* Drag and drop torrents (expand local search database with specific torrents)
* Descriptions association from trackers
* Torrent generation and automatic adding to search DB
* WebSockets & REST API for server/search engine. You can made search request and create your own UI client.
* [WebSockets & REST API for server/search engine. You can made search request and create your own UI client.](docs/API.md)
## Architecture
![Basic Architecture](docs/img/ratsarch.png)
@ -92,6 +92,8 @@ Now you can get access to web interface on 8095 port: http://localhost:8095
[More about server compatibility and known issues](docs/SERVER_COMPATIBILITY.md)
[API usage implementation for clients](docs/API.md)
## Docker image
You can simply run docker image with prepared server version. Just download last sources: