From 4e1c36b570471ceb35301bbc169e7f5db86a8914 Mon Sep 17 00:00:00 2001 From: Klaus Breyer Date: Wed, 4 Oct 2023 21:30:29 +0200 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f62bcd5..24e8177 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# all-the-highlights \ No newline at end of file + +## All The Highlights + +**All The Highlights** is a tool designed to fetch, process, and display book highlights from Readwise. + +### Features: + +- Fetches book data and highlights from the Readwise Export API. +- Filters out books without highlights. +- Generates an HTML representation of the books and their associated highlights. +- Allows easy copy & paste functionality for each highlight and book metadata. +- Automated deployment to GitHub Pages using GitHub Actions. + +### How to Use: + +1. **Set Up**: Clone this repository to your local machine or GitHub workspace. + +2. **Configuration**: Ensure you have a Readwise token. You will need to set this as an environment variable named `READWISE_TOKEN`. + +3. **Run Locally**: Execute the main program using the command `go run main.go`. + +4. **Deployment**: The project is configured with a GitHub Actions workflow (`deploy.yml`) that automatically builds and deploys the generated HTML to GitHub Pages upon push to the `main` branch or on a daily schedule. + +5. **Viewing the Output**: Once deployed, the highlights can be viewed on GitHub Pages at the configured URL. + +### Dependencies: + +- Go programming language (tested with version 1.16). +- Readwise Export API for fetching the book data and highlights. +- The `grr` library for rendering HTML templates. + +### Contributing: + +If you have suggestions, bug reports, or feature requests, please open an issue on the GitHub repository. Contributions via pull requests are also welcome!