v/rarbg
1
0
Fork 0
mirror of https://github.com/lifekiller/rarbg.git synced 2025-05-27 21:00:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
banteg 2015-12-15 18:02:05 +06:00
parent 2d0ae85196
commit fe63362035
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
readme.md
View File

@ -1,12 +1,24 @@
# rarbg → rss
Adapter for [Torrent API](https://torrentapi.org/apidocs_v2.txt) that serves search results as broadcatching-ready RSS feed.
Adapter for Torrent API ([see docs](https://torrentapi.org/apidocs_v2.txt)) that serves search results as broadcatching-ready RSS feed.
# Installation
Requires Python 3.5 or later.
```
pip install git+https://github.com/banteg/rarbg
```
## Usage
`/` main endpoint, pass parameters as you would pass them to API.
Run the server by typing `rarbg`.
Note that API has rate limit of one request per two seconds.
Access it by passing parameters to `http://localhost:8080/` as you would pass them to Torrent API.
Note that Torrent API has a rate limit of one request per two seconds.
Token updates and rate limits are handled automatically.
### Convenience methods