From dafb960f1ab31ba99ce52faff9b900ca87735137 Mon Sep 17 00:00:00 2001
From: Eduard Prigoana <eduard@prigoana.com>
Date: Sun, 16 Feb 2025 15:53:08 +0200
Subject: [PATCH] Create README.md

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e2d5cd7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# TV
+
+Python-based web service designed to aggregate M3U streams from multiple sources, combine them into a single playlist, and offer the ability to create custom playlists from those streams. Currently, it features around 13,000 different channels, though many links are dead.
+
+The service is split into two parts:
+- **[Playlist Creator](https://tv.prigoana.com/)**
+- **[Playlist Aggregator](https://m3u.prigoana.com/all.m3u)**
+
+## Roadmap
+- Combine both scripts into a single, unified solution
+- Implement functionality to test for dead links
+- Improve code quality and optimize performance
+- Transition to a production-grade WSGI server
+- Add NSFW streams in a separate playlist
+- Docker support
+- Front-End improvements
+
+## Deploying
+
+To deploy the service locally, follow these steps:
+
+1. Install the necessary dependencies:
+   ```
+   pip install -r requirements.txt
+   ```
+Depending on your use case, run one of the following commands:
+To create your own playlists (via the app):
+```
+python app.py
+```
+To aggregate the streams (via the generator):
+```
+python gen.py
+```