Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
katydecorah committed Dec 21, 2023
1 parent 9c6979f commit b2b6258
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,9 @@ This GitHub action tracks the books that you read by updating a JSON file in you

[Create a workflow dispatch event](https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event) with information about the book. The action will then fetch the book's metadata using [node-isbn](https://www.npmjs.com/package/node-isbn) and commit the change in your repository, always sorting by the date you finished the book.

## Book status
## Book lifecycle

There are four statuses a book can have:

1. want to read
2. started
3. finished
4. abandoned
When you add or update a book, you can set it as: want to read, started, finished, or abandoned. This will set the value as `bookStatus` and will add an accompanying date for the status.

<!-- START GENERATED DOCUMENTATION -->

Expand Down Expand Up @@ -316,8 +311,6 @@ To trigger the action, [create a workflow dispatch event](https://docs.github.co
}
```



## Action outputs

- `nowReading`: When a new book is started this output will contain an object with the book's: title, description, thumbnail, authors, and isbn.
Expand Down

0 comments on commit b2b6258

Please sign in to comment.