aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTolmachev Igor <me@igorek.dev>2024-09-15 13:34:00 +0300
committerTolmachev Igor <me@igorek.dev>2024-09-15 13:40:42 +0300
commit84e5548599a0145daeade340d2afd90ad32a614d (patch)
tree1d95281e1cdbac8e468854c737b50c0ea9d85b41 /README.md
parent19606a6ac95e83a33c1173dba3e5d6f9f8fb9f94 (diff)
downloadvideo2story-84e5548599a0145daeade340d2afd90ad32a614d.tar.gz
video2story-84e5548599a0145daeade340d2afd90ad32a614d.zip
Fix readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 8 insertions, 10 deletions
diff --git a/README.md b/README.md
index 376815c..eaded00 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,6 @@
4 4
5## Installation 5## Installation
6 6
7To install `video2story`, use pip:
8
9```bash 7```bash
10pip install video2story 8pip install video2story
11``` 9```
@@ -14,24 +12,24 @@ pip install video2story
14 12
15### 1. Process the video 13### 1. Process the video
16 14
15Split the video into segments.
16
17```bash 17```bash
18video2story video input.mp4 output_dir/ 18video2story video input.mp4 output_dir/
19``` 19```
20 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: 21Replace `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:
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 22
25### 2. Upload the processed video 23### 2. Upload the processed video
26 24
25Upload the video segments to your Telegram account.
26
27```bash 27```bash
28video2story PHONE_NUMBER output_dir/ -p friends 28video2story story PHONE_NUMBER output_dir/ -p friends
29``` 29```
30 30
31Replace `PHONE_NUMBER` with your Telegram phone number and `output_dir/` with the directory containing the processed video segments. 31Replace `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.
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 32
35## License 33## License
36 34
37This project is licensed under the GPL (GNU General Public License). See the [LICENSE](/LICENSE) file for more details. 35This project is licensed under the GPL (GNU General Public License). See the [LICENSE](https://codeberg.org/igorechek06/video2story/src/branch/v1/LICENSE) file for more details.