Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tatsumoto-ren committed Apr 20, 2024
1 parent 71aa35d commit 91cb03e
Showing 1 changed file with 26 additions and 16 deletions.
42 changes: 26 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,38 @@ The main benefit of having all subtitles saved locally
is that you can browse them using [lf](https://wiki.archlinux.org/title/Lf)
and quickly search with [fzf](https://wiki.archlinux.org/title/Fzf).

## Usage
## Install

Install using [pipx](https://pipx.pypa.io/stable/).

```bash
pipx install kitsunekko-tools
```

## Configure

1) Clone the repository.
2) Change [settings](settings.json).
Run this command to create the config file.

``` bash
vim settings.json
```
```bash
ktools config create
```

Or you can copy the config file to `~/.config/kitsunekko-tools/settings.json` and edit it there.
Edit the config file.

* `destination` - the local folder the files should be downloaded to.
* `proxy` - Your proxy settings.
Set to `null` if you don't use proxies.
By default, it is set to the Tor address.
* `destination` - the local folder where the files should be downloaded.
* `proxy` - Your proxy settings.
Set to `null` if you don't use proxies.
By default, it is set to the default Tor address.

Everything else usually doesn't need to be changed.

## Usage

Everything else usually doesn't need to be changed.
3) Run.
Run sync.

``` bash
ktools sync
```
``` bash
ktools sync
```

## Upload your mirror to Mega

Expand Down

0 comments on commit 91cb03e

Please sign in to comment.