diff --git a/README.md b/README.md index e1d70e4..375887e 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,32 @@ 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 -## 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 - +go run . ``` ## Building from source @@ -24,8 +44,6 @@ Standalone: make build ``` -## Resources - ## Contributing If you find a bug or have an idea for a new feature please [raise an issue](issues/new) to discuss it. diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..0c3c4e5 Binary files /dev/null and b/screenshot.png differ