aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..376815c 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,37 @@
1# video2story
2
3**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.
4
5## Installation
6
7To install `video2story`, use pip:
8
9```bash
10pip install video2story
11```
12
13## Usage
14
15### 1. Process the video
16
17```bash
18video2story video input.mp4 output_dir/
19```
20
21First, 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:
22
23By default, the video will be cut into 60-second segments. To change that, use the `-d` option and specify the duration in seconds:
24
25### 2. Upload the processed video
26
27```bash
28video2story PHONE_NUMBER output_dir/ -p friends
29```
30
31Replace `PHONE_NUMBER` with your Telegram phone number and `output_dir/` with the directory containing the processed video segments.
32
33The `-p` option allows you to choose the privacy level for your story. For more options and detailed information, use the `--help` flag.
34
35## License
36
37This project is licensed under the GPL (GNU General Public License). See the [LICENSE](/LICENSE) file for more details.