Skip to content

Commit d098320

Browse files
committed
[toru] add a shell.nix file update readme
1 parent e6ba9b2 commit d098320

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ like any other http link. `toru` can also be used as a makeshift torrent client
4747

4848
## Install
4949

50+
<details closed>
51+
<summary>Install Go</summary>
52+
<a href="https://go.dev/doc/install">Install go</a>
53+
Go should also be available in most distro's package managers, as well as scoop and brew.
54+
</details>
55+
5056
```sh
5157
go install github.com/sweetbbak/toru/cmd/toru@latest
5258
```
@@ -55,28 +61,46 @@ go install github.com/sweetbbak/toru/cmd/toru@latest
5561
git clone https://github.com/sweetbbak/toru.git && cd toru
5662
go build
5763
```
58-
automated pre-built binaries builds coming soon...
64+
65+
you can also use the justfile, the shell.nix file, or the Containerfile that is podman/docker agnostic
66+
```sh
67+
git clone https://github.com/sweetbbak/toru.git && cd toru
68+
just
69+
```
70+
71+
Using `docker`, `podman` and `shell.nix`
72+
```sh
73+
git clone https://github.com/sweetbbak/toru.git && cd toru
74+
pm run --volume $(pwd):/toru -ti docker.io/nixos/nix:latest
75+
# inside the container run:
76+
cd toru
77+
nix-shell
78+
just
79+
```
80+
if you are on nix or have nix installed you can just use the shell.nix directly.
81+
82+
automated pre-built builds coming soon...
5983

6084
## Examples
6185

6286
Search for an anime:
6387
```sh
6488
toru search -i
89+
toru search ""
6590
```
6691
![example of toru in progress](assets/search.png)
6792

6893
the selected torrent will begin playing and once the video player is closed
6994
you will have the option to select another episode, make another search query,
7095
or to exit.
7196

72-
*View* the latest anime on nyaa.si in an interactive fzf session
97+
#### *View* the latest anime on nyaa.si in an interactive fzf session
7398
```sh
7499
toru search --latest
75100
```
76101

77-
Search for a specific keyword
102+
#### Search for a specific keyword or series
78103
```sh
79-
# Search for a series
80104
toru search "Akuyaku"
81105
```
82106

@@ -99,13 +123,13 @@ Output in Json and parsing that output with `jq`:
99123
toru search --latest --json | jq -r '.[]|.Name,.Magnet'
100124
```
101125

102-
Open a cached search session from a json file
126+
#### Open a cached search session from a json file
103127
```sh
104128
toru search --json "one piece" > cache.json
105129
toru search --from-json cacne.json --interactive
106130
```
107131

108-
Output in a human readable pretty format:
132+
#### Output in a human readable format:
109133

110134
```sh
111135
toru search "akuyaku 99 1080p"

0 commit comments

Comments
 (0)