diff --git a/README.md b/README.md index d237a3bf9..a2c3f6f86 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,37 @@ ![Issues](https://img.shields.io/github/issues/adityachandelgit/BookLore) ![Stars](https://img.shields.io/github/stars/adityachandelgit/BookLore?style=social) [![Join us on Discord](https://img.shields.io/badge/Chat-Discord-blue?logo=discord&style=flat)](https://discord.gg/Ee5hd458Uz) +[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/booklore?label=Open%20Collective&logo=opencollective&color=blue)](https://opencollective.com/booklore) +[![Venmo](https://img.shields.io/badge/Venmo-Donate-blue?logo=venmo)](https://venmo.com/AdityaChandel) BookLore is a self-hosted web app for organizing and managing your personal book collection. It provides an intuitive interface to browse, read, and track your progress across PDFs and eBooks. With robust metadata management, multi-user support, and a sleek, modern UI, BookLore makes it easy to build and explore your personal library. ![BookLore Demo](assets/demo.gif) -## πŸ’ƒ Live Demo +## ✨ Key Features + +- πŸ“š **Powerful Book Organization**: Keep your library organized with Libraries and Shelves. Sort by genre, author, or mood to find books easily. +- 🧠 **Intelligent Metadata Management**: Fetch rich metadata from Goodreads, Amazon, Google Books, Hardcover, and more, or fine-tune details with the advanced editor. +- πŸ‘₯ **Multi-User Access with Permissions**: Add users, assign libraries, and control who can edit, upload, or download. Great for families, friends, or teams. +- πŸ“– **Built-in PDF, ePub, and CBX Reader**: Enjoy a smooth, distraction-free reading experience in your browser, with theme and setting options. +- 🌐 **OPDS 1.2 Integration**: Connect BookLore to favorite reading apps with full OPDS support for seamless downloads. +- πŸ” **Flexible Authentication**: Secure your library with optional OIDC login (Authentik, Pocket ID) or local JWT, your choice. +- πŸ“€ **Smart Batch Upload with BookDrop Folder**: Drop dozens of books into the BookDrop folder; BookLore scans, organizes, and fetches metadata automatically. +- πŸ“§ **Send Books by Email**: Easily share books by sending them directly via email from within BookLoreβ€”one click delivery. +- πŸ“± **Mobile-Optimized UI**: Responsive design for phones and tablets lets you manage your library anywhere. +- πŸ”„ **Open Source & Self-Hosted**: Full control of your digital library with open-source, self-hosted BookLore. +- πŸš€ **Active Development**: Continuous improvements with regular updates to features, UI, and performance. + +## πŸ’– Support the Project + +If you find **BookLore** helpful, please consider supporting its development: + +- ⭐ Star this repository to show your appreciation and help others discover it. +- πŸ’Έ Contribute via [Open Collective](https://opencollective.com/booklore) to help fund development, hosting, and testing costs. + > πŸ“Œ **First goal**: Funding a **Kobo device** to implement and test native Kobo sync support. +- ⚑ Prefer one-time support? You can also donate via [Venmo](https://venmo.com/AdityaChandel). + +## 🌐 Live Demo Try it for yourself with the [public live demo](https://demo-booklore.elfhosted.com), sponsored by [ElfHosted](https://elfhosted.com) :heart:, using the following details: @@ -18,22 +43,9 @@ Try it for yourself with the [public live demo](https://demo-booklore.elfhosted. (*the demo resets every hour, on the hour, no copyrighted content uploads please*) -## ✨ Key Features - -- πŸ“š **Powerful Book Organization**: Keep your library tidy with **Libraries** and **Shelves**. Whether you're sorting by genre, author, or mood, finding the right book is effortless. -- 🧠 **Intelligent Metadata Management**: Instantly fetch rich metadata from **Goodreads**, **Amazon**, **Google Books**, **Hardcover**, and more, or fine-tune every detail yourself with our advanced editor. -- πŸ‘₯ **Multi-User Access with Permissions**: Add users, assign libraries, and control who can edit, upload, or download. Perfect for families, friends, or teams. -- πŸ“– **Built-in PDF, ePub, and CBX Reader**: Enjoy a smooth, distraction-free reading experience directly in your browser. Supports themes and adjustable settings. -- 🌐 **OPDS 1.2 Integration**: Connect BookLore to your favorite reading apps with full **OPDS** support for seamless downloads. -- πŸ” **Flexible Authentication**: Secure your library with optional **OIDC login** via providers like **Authentik** and **Pocket ID**, or stick with local **JWT**, the choice is yours. -- πŸ“€ **Smart Batch Upload with BookDrop Folder**: Drop dozens of books into the **BookDrop Folder**, and BookLore will automatically scan, organize, and fetch metadata for all of them, hands-free and efficient. -- πŸ“§ **Send Books by Email**: Seamlessly share books with friends or your own devices by sending them directly via email from within BookLore. Just one click, and it’s delivered. -- πŸ“± **Mobile-Optimized UI**: Sleek, responsive design tailored for phones and tablets. Manage your library from anywhere, effortlessly. -- πŸ”„ **Open Source & Self-Hosted**: Take full control of your digital library with BookLore’s open-source, self-hosted design. -- πŸš€ **Active Development**: BookLore is under continuous improvement with regular updates to features, UI, and performance. - ## πŸš€ Getting Started with BookLore + Kick off your BookLore journey with our official documentation and helpful video guides. πŸ“˜ [BookLore Documentation: Getting Started](https://adityachandelgit.github.io/booklore-docs/docs/getting-started) @@ -172,15 +184,6 @@ Thanks to all the amazing people who contribute to Booklore. [![Star History Chart](https://api.star-history.com/svg?repos=adityachandelgit/BookLore&type=Date&theme=dark)](https://star-history.com/#adityachandelgit/BookLore&Date&theme=dark) -## πŸ’– Support the Project - -If you find BookLore helpful, consider ⭐ starring the repo! - -Or support the project via [Venmo](https://venmo.com/AdityaChandel): - -[![Venmo](https://img.shields.io/badge/Venmo-Donate-blue?logo=venmo)](https://venmo.com/AdityaChandel) - - ## 🧰 Tech Stack