From 19606a6ac95e83a33c1173dba3e5d6f9f8fb9f94 Mon Sep 17 00:00:00 2001
From: Tolmachev Igor <me@igorek.dev>
Date: Sun, 15 Sep 2024 13:14:54 +0300
Subject: Add README and fix package props

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e69de29..376815c 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,37 @@
+# video2story
+
+**video2story** is a Python tool that allows you to convert and upload videos to your Telegram stories. It automatically cuts the video into segments and uploads them to your Telegram account.
+
+## Installation
+
+To install `video2story`, use pip:
+
+```bash
+pip install video2story
+```
+
+## Usage
+
+### 1. Process the video
+
+```bash
+video2story video input.mp4 output_dir/
+```
+
+First, split the video into segments. Replace `input.mp4` with the path to your video file and `output_dir/` with the directory where you want to save the processed segments:
+
+By default, the video will be cut into 60-second segments. To change that, use the `-d` option and specify the duration in seconds:
+
+### 2. Upload the processed video
+
+```bash
+video2story PHONE_NUMBER output_dir/ -p friends
+```
+
+Replace `PHONE_NUMBER` with your Telegram phone number and `output_dir/` with the directory containing the processed video segments.
+
+The `-p` option allows you to choose the privacy level for your story. For more options and detailed information, use the `--help` flag.
+
+## License
+
+This project is licensed under the GPL (GNU General Public License). See the [LICENSE](/LICENSE) file for more details.
-- 
cgit v1.2.3