Skip to content
This repository was archived by the owner on Apr 17, 2023. It is now read-only.

Commit 94d7e68

Browse files
committed
Add documentations of usage
1 parent 748bc55 commit 94d7e68

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,36 @@
1515
pip install twitter-video-tools
1616
```
1717

18-
### with Poetry (Recommended)
18+
### with Poetry
1919

2020
```sh
2121
poetry add twitter-video-tools
2222
```
2323

24+
## Usage
25+
26+
### Command line
27+
28+
```sh
29+
python3 -m twitter_video_tools [link]
30+
```
31+
32+
Supported link types:
33+
34+
- Video tweet: <https://twitter.com/twtvtOfficial/status/1599748329927499777>
35+
- Video from monsnode: <https://monsnode.com/v1506575871309589251>
36+
- Specific user's uploaded videos: <https://twitter.com/twtvtOfficial/media>
37+
- Specific user's liked videos: <https://twitter.com/twtvtOfficial/likes>
38+
39+
### Python Embedding
40+
41+
```python
42+
from twitter_video_tools import TwitterVideoTools
43+
44+
with TwitterVideoTools() as twitter_video_tools:
45+
twitter_video_tools.download_from_user('twtvtOfficial')
46+
```
47+
2448
## Contribution
2549

2650
### Prerequisites

0 commit comments

Comments
 (0)