KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

bookshelf-action

★ 72 Open GitHub ↗

📚 Track your reading using GitHub Actions

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [![Books Tracker](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/logo.svg)](https://anandchowdhary.github.io/bookshelf-action/)

Track your reading using repository issues and generate a README.md and open API automagically.

[![Build CI](https://github.com/AnandChowdhary/bookshelf-action/workflows/Build%20CI/badge.svg)](https://github.com/AnandChowdhary/bookshelf-action/actions?query=workflow%3A%22Build+CI%22)
[![Release CI](https://github.com/AnandChowdhary/bookshelf-action/workflows/Release%20CI/badge.svg)](https://github.com/AnandChowdhary/bookshelf-action/actions?query=workflow%3A%22Release+CI%22)
[![Node CI](https://github.com/AnandChowdhary/bookshelf-action/workflows/Node%20CI/badge.svg)](https://github.com/AnandChowdhary/bookshelf-action/actions?query=workflow%3A%22Node+CI%22)

[**View starter repository →**](https://github.com/AnandChowdhary/books)

## ⭐ Features

- End-to-end automated workflow using GitHub issues:
  - Create GitHub issues to add the books you're reading
  - Track your reading progress by adding comments to the issue
  - Close the issue when you've completed the book
- Get a README.md summary and JSON API for your reading data
- Uses Google Books API to fetch details like cover and ISBN

### Get started

This repository only includes the GitHub Actions required as dependencies. To get started, [**visit AnandChowdhary/books**](https://github.com/AnandChowdhary/books) and use it as a starting point. You can use the [Use this template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) button to create a new repository:

1. Go to [AnandChowdhary/books](https://github.com/AnandChowdhary/books)
2. Click on the "Use this template" button or fork the repository
3. Add a book by creating a new issue with the book's name

First, create a new issue in your repository:

![Screenshot of new issue button](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/new-issue.png)

Then, write the name of the book and author as the issue title:

![Screenshot of issue title](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/book-title-in-issue.png)

Lastly, press the "Submit new issue" button and you'll see a comment and labels added automatically:

![Screenshot of comment in issue](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/issue-bot-comment.png)

</details>

<details>
  <summary>How to update reading progress</summary>

In your book's issue, simply enter in plain text the progress. For example, "I've reached page 100" or "I've completed 24%", or "I've reached page 42/542". The issue title will be automatically updated to include your reading progress:

![Screenshot of new issue button](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/issue-title-progress.png)

</details>

<details>
  <summary>How to complete reading a book</summary>

When you've completed a book, simply close the issue. An automated comment will be added to tell you about your reading time and some new labels will be added.

![Screenshot of new issue button](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/issue-close-completed.png)

</details>

When creating a new issue for the book, add the label "want to read".

</details>

## 📖 Example

Simply create issues with names of books, and Bookshelf Action will automatically organize them with labels:

![Screenshot of issues](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/issues.png)

Additionally, a summary of your reading progress is generated in the `README.md` file:

![Screenshot of README](https://raw.githubusercontent.com/AnandChowdhary/bookshelf-action/master/assets/readme-demo.png)

## 📄 License

- Code: [MIT](./LICENSE) © [Anand Chowdhary](https://anandchowdhary.com)
- Books icon by [Francielly Costantin Senra](https://thenounproject.com/franciellycs/) from [The Noun Project](https://thenounproject.com)
- Merge icon by [Danil Polshin](https://thenounproject.com/everydaytemplate) from [The Noun Project](https://thenounproject.com)
- "GitHub" is a trademark of GitHub, Inc.

bookshelf-action

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README