Skip to content

Commit fe6b497

Browse files
author
Darren Reddick
committed
update README [skip ci]
1 parent 7f989d1 commit fe6b497

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,34 @@ A simple cobra-based cli for searching mixcloud.
99

1010
## :musical_keyboard: Overview
1111

12+
[Mixcloud](https://www.mixcloud.com/) is an amazing service for discovering and listening to radio shows, DJ mixes and podcasts.
13+
1214
The mixcloud web interface can be cumbersome when trying to search for mixes with specific terms etc. This project was created as a way to search mixcloud for mix data with a quick and simple search.
1315

16+
The cli supports searching for a term on mixcloud and then filtering the results (client-side) using arrays of exclude and include terms.
17+
18+
Currently the results are output as json to file **test.json** (early days!).
19+
20+
## :factory: Installing
21+
22+
### :page_facing_up: Prerequisites
23+
24+
- Go (>=1.17)
25+
26+
### :wrench: Building the cli
27+
28+
Select the appropriate build command from below. This will output the cli binary into the current directory.
29+
30+
```
31+
# Mac M1
32+
GOOS=darwin GOARCH=arm64 go build -o gmc
33+
# Mac Intel
34+
GOOS=darwin GOARCH=amd64 go build -o gmc
35+
# Linux
36+
GOOS=linux go build -o gmc
37+
```
38+
39+
1440
## :notebook_with_decorative_cover: Usage
1541

1642
The cli supports the following subcommands
@@ -31,6 +57,14 @@ Flags:
3157
-t, --term string Search term
3258
```
3359

60+
#### :stars: Example usage
61+
62+
```
63+
gmc search --term truncate --include berghain --exclude 2016
64+
```
65+
66+
67+
3468
### :scroll: history
3569

3670
```
@@ -47,3 +81,9 @@ Flags:
4781
-u, --user string User name to search
4882
```
4983

84+
#### :stars: Example usage
85+
86+
```
87+
gmc history --user akumad --include party
88+
```
89+

0 commit comments

Comments
 (0)