Skip to content

Commit f36de7a

Browse files
authored
docs: update readme (#9)
2 parents 049fa06 + fa397d3 commit f36de7a

File tree

3 files changed

+38
-6
lines changed

3 files changed

+38
-6
lines changed

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,58 @@
11
# Bunkrr Uploader
22

3-
WORK IN PROGRESS
4-
53
## Supports
64
- Bunkrr accounts
75
- Parallel uploads
86
- Retries
97
- Progress bars
108

9+
<div align="center">
10+
11+
12+
![Preview1](https://raw.githubusercontent.com/NTFSvolume/bunkrr-uploader/refs/heads/master/assets/preview1.png)
13+
14+
![Preview2](https://raw.githubusercontent.com/NTFSvolume/bunkrr-uploader/refs/heads/master/assets/preview2.png)
15+
16+
</div>
17+
18+
19+
```bash
20+
usage: main.py [-h] [-t str] [-n str] [-c int] [--chunk-size ByteSize] [--use-max-chunk-size bool] [--public bool] [--config-file {Path,null}] [--upload-retries int] [--chunk-retries int] PATH
21+
22+
positional arguments:
23+
PATH File or directory to look for files in to upload
24+
25+
options:
26+
-h, --help show this help message and exit
27+
-t str, --token str API token for your account so that you can upload to a specific account/folder. You can also set the BUNKR_TOKEN environment variable for this (required)
28+
-n str, --album-name str
29+
(default: )
30+
-c int, --concurrent-uploads int
31+
Maximum parallel uploads to do at once (default: 2)
32+
--chunk-size ByteSize
33+
--use-max-chunk-size bool
34+
Use the server's maximum chunk size instead of the default one (default: True)
35+
--public bool Make all files uploaded public (default: True)
36+
--config-file {Path,null}
37+
(default: null)
38+
--upload-retries int How many times to retry a failed upload (default: 1)
39+
--chunk-retries int How many times to retry a failed chunk or chunk completion (default: 2)
40+
```
41+
1142
# TODO
12-
- [ ] Use nicegui
1343
- [X] Slit API and UploadClient
14-
- [ ] Migrate to `~~Niquests~~ aiohttp
44+
- [X] Migrate to aiohttp
1545
- [ ] Upload logging
16-
- [ ] Replace tqdm with rich progress
46+
- [X] Replace tqdm with rich progress
1747
- [ ] Skipping duplicate uploads
1848
- [ ] Private and public directory uploads
1949
- [ ] Update README
20-
- [ ] Make it work
50+
- [X] Make it work
2151
- [ ] Add file zipping and cleanup
2252
- [ ] Add tests
2353
- [ ] Add github runners for tests
2454
- [X] Recursive directory upload support
2555
56+
57+
2658
Original code by [alexmi256](https://github.com/alexmi256/bunkrr-uploader)

assets/preview1.png

61.7 KB
Loading

assets/preview2.png

93 KB
Loading

0 commit comments

Comments
 (0)