Updated readme

Signed-off-by: Marcus Noble <github@marcusnoble.co.uk>
This commit is contained in:
2026-03-01 11:53:00 +00:00
parent 38313272fe
commit a7991cb87d
2 changed files with 22 additions and 4 deletions

View File

@@ -2,12 +2,32 @@
Checks the users Storygraph "to read" list and shows the highest rated in various catergories. Checks the users Storygraph "to read" list and shows the highest rated in various catergories.
![](./screenshot.png)
Note: This is likely to break as currently there is no Storygraph API and this relies on HTML parsing.
## Features ## Features
## Install * Uses the users cookie to authenticate
* Shows the top rated book from the users "To read" list grouped into the following categories:
* Fiction
* Non-Fiction
* Comics
* Art
* Business
* Fantasy
* Health
* Sci-Fi
* Technology
* The next 5 highest rated in each category can be displayed in a modal popup
* The listings are refreshed hourly
## Running
You must first get the cookie for your Storygraph user account and setting it as the `COOKIE` environment variable.
```sh ```sh
go run .
``` ```
## Building from source ## Building from source
@@ -24,8 +44,6 @@ Standalone:
make build make build
``` ```
## Resources
## Contributing ## Contributing
If you find a bug or have an idea for a new feature please [raise an issue](issues/new) to discuss it. If you find a bug or have an idea for a new feature please [raise an issue](issues/new) to discuss it.

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 MiB