mirror of
https://github.com/knightcrawler-stremio/knightcrawler.git
synced 2024-12-20 03:29:51 +00:00
Add an overview section to the README
This commit is contained in:
14
README.md
14
README.md
@@ -1,8 +1,16 @@
|
||||
# Torrentio
|
||||
# Selfhostio
|
||||
|
||||
- [torrentio-addon](addon) - the Stremio addon which will query scraped entries and return Stremio stream results.
|
||||
A self-hosted Stremio addon for streaming torrents via a debrid service.
|
||||
|
||||
## Overview
|
||||
|
||||
Stremio is a media player. On it's own it will not allow you to watch anything. This addon at it's core does the following:
|
||||
|
||||
1. It will search the internet and collect information about movies and tv show torrents, then store it in a database.
|
||||
2. It will then allow you to click on the movie or tv show you desire in Stremio and play it with no further effort.
|
||||
|
||||
## Using
|
||||
|
||||
## Self-hosted quickstart
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user