Socket
Socket
Sign inDemoInstall

bookshelf-action

Package Overview
Dependencies
11
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    bookshelf-action

Track your reading using GitHub Actions


Version published
Weekly downloads
9
Maintainers
1
Install size
68.5 MB
Created
Weekly downloads
 

Changelog

Source

v1.1.0 (2023-01-14)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

🐛 Bug fixes

  • 27edabc Ensure comment body exists
  • 4b73ff6 Fix fallback cover URL
  • 393b5c6 Add new line before heading, fixed #108 (Issues: #108)

⬆️ Dependency updates

  • 17d0561 Bump stefanzweifel/git-auto-commit-action
  • ed524de Bump actions/setup-node from v2.1.4 to v2.1.5
  • 3912cf2 Bump typescript from 4.1.5 to 4.2.2
  • 73858c3 Bump ts-jest from 26.5.1 to 26.5.2
  • 3c755f0 Bump stefanzweifel/git-auto-commit-action
  • ea04fb5 Bump semantic-release from 17.3.9 to 17.4.0
  • e636906 Bump got from 11.8.1 to 11.8.2
  • 2b514be Bump semantic-release from 17.4.0 to 17.4.1
  • 8318fb1 Bump ts-jest from 26.5.2 to 26.5.3
  • 73454fa Bump stefanzweifel/git-auto-commit-action
  • 7b1adb8 Bump typescript from 4.2.2 to 4.2.3
  • 77aa071 Update all dependencies

Readme

Source

Books Tracker

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

Build CI Release CI Node CI

View starter repository →

⭐ 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 and use it as a starting point. You can use the Use this template button to create a new repository:

  1. Go to 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
How to add a new book

First, create a new issue in your repository:

Screenshot of new issue button

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

Screenshot of issue title

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

Screenshot of comment in issue

How to update reading progress

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

How to complete reading a book

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

How to add a book as "Want to read"

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

📖 Example

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

Screenshot of issues

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

Screenshot of README

📄 License

Keywords

FAQs

Last updated on 14 Jan 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc