26
README.md
26
README.md
@@ -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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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
BIN
screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.6 MiB |
Reference in New Issue
Block a user