Skip to content

Commit a93f734

Browse files
author
Sav S. Mach
committed
Refine the documentation.
Signed-off-by: Sav S. Mach <sav@loophole.cc>
1 parent 75b27c2 commit a93f734

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1-
# brainz
2-
A collection of scripts to deal with ListenBrainz data.
1+
# Brainz
2+
3+
A simple script to search and delete [ListenBrainz](https://listenbrainz.org) listens.
34

45
## Installation
56

7+
```
68
go install github.com/sav/brainz@latest
9+
```
710

8-
## Build
11+
## Usage
912

10-
go build
13+
First define `BRAINZ_TOKEN` environment with an API Token from [ListenBrainz](https://listenbrainz.org) website:
1114

12-
## Usage
15+
```
16+
export BRAINZ_TOKEN=<token>
17+
```
18+
19+
### Searching
20+
21+
```
22+
./brainz -l -u <user> -s <regexp>
23+
```
24+
25+
### Deleting
1326

14-
./brainz -l -u sav10sena -s '.*'
27+
```
28+
./brainz -d -u <user> -s <regexp>
29+
```

0 commit comments

Comments
 (0)