Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahobsonsayers committed Apr 17, 2024
1 parent faf3cc6 commit 7bb278a
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

A Goodreads Custom Metadata Provider for AudioBookShelf

## Usage
## Run

The best way to run is to use docker
The best way to run abs-goodreads is to use docker.

```bash
docker run -d \
Expand All @@ -14,13 +14,24 @@ docker run -d \
arranhs/abs-goodreads:latest
```

You can then set up abs-goodreads in AudioBookShelf by going to:
## Test

Test abs-goodreads is working using curl.

```bash
ADDRESS=localhost
curl --request GET \
--url "http://$ADDRESS:5555/search?query=The%20Hobbit&author=J.R.R.%20Tolkien"
```

## Setup

You can then set up abs-goodreads in AudioBookShelf.

```
Settings -> Item Metadata Utils -> Custom Metadata Providers -> Add
```


and entering the following details:

- Name: **Goodreads**
Expand All @@ -30,6 +41,3 @@ and entering the following details:
See video below for a walkthrough:

https://github.com/ahobsonsayers/abs-goodreads/assets/32173585/54437af6-a17c-4458-bb82-479b183171da



0 comments on commit 7bb278a

Please sign in to comment.