From 4aecb232150436a2cbbd25724e50e8b22ebaa0cd Mon Sep 17 00:00:00 2001
From: samedamci <samedamci@disroot.org>
Date: Sun, 19 Sep 2021 14:19:39 +0200
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eebb021
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# python-mattebox
+
+Unofficial Python library for MatteBOX IPTV.
+
+<!-- ## Installing
+
+```shell
+$ python -m pip install python-mattebox
+``` -->
+
+## Usage
+
+```python
+>>> from mattebox import MatteBOX
+>>> mbox = MatteBOX(USERNAME, PASSWORD, DEVICE_ID, SUBSCRIPTION_CODE)
+```
+
+### Examples
+
+```python  
+>>> # get list of TV channels
+>>> channels = mbox.channels
+
+>>> # get list of programs on specified channel
+>>> programs = mbox.get_programs(channels[0])
+
+>>> # get recordings
+>>> recordings = mbox.recordings
+
+>>> # get stream URL for specified program/recording
+>>> stream = mbox.get_stream(programs[0])
+
+>>> # search for TV program
+>>> results = mbox.search("Masza i niedźwiedź")
+```