From 2ddd30f6215b62e33fce66fcbe7ad46915391095 Mon Sep 17 00:00:00 2001 From: purple_emily Date: Fri, 2 Feb 2024 15:04:00 +0000 Subject: [PATCH] Add an overview section to the README --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1cf2349..3faf43a 100644 --- a/README.md +++ b/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 ```