chore: add README

This commit is contained in:
metonym 2024-03-03 07:24:41 +01:00
parent 40ca3d0fb0
commit 648d19b5ae
Signed by: metonym
GPG key ID: A9E0123EF1E9B34E

92
README.md Normal file
View file

@ -0,0 +1,92 @@
# ab-smalls
## a quick way to increase your yen yield
### installation
1. download the appropriate zip from the latest release
2. unzip the archive into its own folder
3. update the ab_smalls.toml file with your username and passkey at minimum
4. run the program
5. ???
6. profit
a sort enabled version is available if you would like for the torrent files to be sorted after downloading. the sorted structure can be found below. there is no guarantee the structure won't change since it is made for my storage purposes
```bash
torrents/
├── anime
│   ├── bluray
│   │   ├── episode
│   │   └── raw
│   ├── dvd
│   │   ├── episode
│   │   └── raw
│   ├── h
│   │   ├── bluray
│   │   │   ├── episode
│   │   │   └── raw
│   │   ├── dvd
│   │   │   ├── episode
│   │   │   └── raw
│   │   ├── episode
│   │   ├── ld
│   │   │   ├── episode
│   │   │   └── raw
│   │   ├── raw
│   │   ├── tv
│   │   │   ├── episode
│   │   │   └── raw
│   │   ├── vcd
│   │   │   ├── episode
│   │   │   └── raw
│   │   ├── vhs
│   │   │   ├── episode
│   │   │   └── raw
│   │   └── webdl
│   │   ├── episode
│   │   └── raw
│   ├── ld
│   │   ├── episode
│   │   └── raw
│   ├── tv
│   │   ├── episode
│   │   └── raw
│   ├── vcd
│   │   ├── episode
│   │   └── raw
│   ├── vhs
│   │   ├── episode
│   │   └── raw
│   └── web
│   ├── episode
│   └── raw
├── artbooks
├── books
│   └── raw
├── games
├── live_action
│   ├── bluray
│   │   └── raw
│   ├── dvd
│   │   └── raw
│   ├── ld
│   │   └── raw
│   ├── tv
│   │   └── raw
│   ├── vcd
│   │   └── raw
│   ├── vhs
│   │   └── raw
│   └── web
│   └── raw
├── manga
│   ├── h
│   │   └── raw
│   └── raw
├── music
│   └── videos
├── packs
└── vn
```
## development
PRs are welcome if you have something other people can use, ping me on AB (site or irc) for reviews