Skip to content
This repository was archived by the owner on Jan 29, 2025. It is now read-only.

Commit d6a03af

Browse files
committed
feat: update documentation with browse options
1 parent 7617586 commit d6a03af

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/menzerath/monstercat-api/go)
44
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/menzerath/monstercat-api)
5-
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/menzerath/monstercat-api/monstercat?tab=doc)
5+
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/menzerath/monstercat-api/v2/monstercat)
66

77
Go-based wrapper and CLI to access Monstercat's API for releases and tracks.
88

@@ -32,19 +32,21 @@ $ ./monstercat catalog --search="mix contest"
3232
| CATALOG ID | TITLE | ARTIST | TYPE | RELEASE DATE |
3333
+------------+-------------------------------------------------+------------+---------+--------------+
3434
| MMC604 | S6E4 - The Mix Contest - "You & Me" | Monstercat | Podcast | 2021-08-11 |
35-
| MMC603 | S6E3 - The Mix Contest - Orbit | Monstercat | Podcast | 2021-08-04 |
36-
| MMC602 | S6E2 - The Mix Contest - There and Back | Monstercat | Podcast | 2021-07-28 |
37-
| MMC601 | S6E1 - The Mix Contest - Opening Ceremonies | Monstercat | Podcast | 2021-07-21 |
35+
| MMC603 | S6E3 - The Mix Contest - "Orbit" | Monstercat | Podcast | 2021-08-04 |
36+
| MMC602 | S6E2 - The Mix Contest - "There and Back" | Monstercat | Podcast | 2021-07-28 |
37+
| MMC601 | S6E1 - The Mix Contest - "Opening Ceremonies" | Monstercat | Podcast | 2021-07-21 |
3838
| MMCS600 | The Mix Contest 2021 - Submissions Open Now! | Monstercat | Podcast | 2021-05-19 |
3939
| MMC508 | The Mix Contest 2020 - Winner’s Showcase | Monstercat | Podcast | 2020-09-23 |
40-
| MMC507 | S5E7 - The Mix Contest - Showdown | Monstercat | Podcast | 2020-09-02 |
41-
| MMC506 | S5E6 - The Mix Contest - Unity | Monstercat | Podcast | 2020-08-26 |
42-
| MMC505 | S5E5 - The Mix Contest - Bittersweet Horizons | Monstercat | Podcast | 2020-08-19 |
43-
| MMC504 | S5E4 - The Mix Contest - How We Win, Together | Monstercat | Podcast | 2020-08-12 |
40+
| MMC507 | S5E7 - The Mix Contest - "Showdown" | Monstercat | Podcast | 2020-09-02 |
41+
| MMC506 | S5E6 - The Mix Contest - "Unity" | Monstercat | Podcast | 2020-08-26 |
42+
| MMC505 | S5E5 - The Mix Contest - "Bittersweet Horizons" | Monstercat | Podcast | 2020-08-19 |
43+
| MMC504 | S5E4 - The Mix Contest - "How We Win, Together" | Monstercat | Podcast | 2020-08-12 |
4444
+------------+-------------------------------------------------+------------+---------+--------------+
4545
10 of 25 results
4646
```
4747

48+
A list of all configurable options can be obtained by adding the `--help` flag to any command.
49+
4850
### API
4951

5052
To use this project in your own work, follow these steps:
@@ -65,11 +67,13 @@ import (
6567

6668
func main() {
6769
client := monstercat.NewClient()
68-
catalog, err := client.Catalog("mix contest", "podcast", 5, 0)
70+
catalog, err := client.BrowseCatalog(WithSearch("mix contest"))
6971
if err != nil {
7072
fmt.Printf("error: %s", err)
7173
os.Exit(1)
7274
}
7375
fmt.Printf("catalog: %+v", catalog)
7476
}
7577
```
78+
79+
A list of all `BrowseOption`s is available in our [API documentation](https://pkg.go.dev/github.com/menzerath/monstercat-api/v2/monstercat#BrowseOption).

0 commit comments

Comments
 (0)