th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Documentation and Readme

Browse Source
This commit is contained in:
th3r00t
2025-08-09 19:15:09 +00:00
parent 75d52fac56
commit e01fcaa965
1 changed files with 18 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md vendored
View File

@@ -1,20 +1,20 @@
# pyShelf 0.8.0
<p align="center"><b>Terminal based ebook server. Open source & Lightweight.</b></p>
<p align="center">Having used Calibre for hosting my eBook collection in the past, I found myself frustrated having to install X on my server, or manage my library externally, Thus I have decided to spin up my own.</p>
<p align="center">
Having used Calibre for hosting my eBook collection in the
past, I found myself frustrated having to install X on my server, or manage my
library externally, Thus I have decided to spin up my own.
</p>
![pyShelf 0.6.0 newui](https://github.com/th3r00t/pyShelf/raw/master/src/interface/static/img/pyShelf_frontend_0_2_0.png)
### You dont need an X server to host a website, Movies or Tv, so why should you need one to host ebooks?
### You dont need an X server to host a website, or your Movie & Tv collection, so why should you need one to host ebooks?
_Other solutions require you to have access to an X server to at the very least
generate your book database, pyShelf doesnt. We aim to provide a fully featured
ebook server with minimal requirements, and no reliance on X whatsoever._
_Other solutions require you to have access to an X server to at the very least generate your book database, pyShelf doesnt. We aim to provide a fully featured ebook server with minimal requirements, and no reliance on X whatsoever._
Follow or influence development @ <p align="center"><b>
<a href="https://discord.gg/H9TbNJS">Discord</a>
</b></p>
## 0.8.0 Patch Notes.
Follow or influence development @ <p align="center"><b><a href="https://discord.gg/H9TbNJS">Discord</a></b></p>
## Features
@@ -26,7 +26,6 @@ Follow or influence development @ <p align="center"><b>
- The Expanse
* Download System
* Automated Collections based on folder structure
* Expanded book information view
| Branch | Support | Feature set |
| --- | --- | --- |
@@ -50,18 +49,14 @@ Follow or influence development @ <p align="center"><b>
### Organizational tools.
- [x] Automated Collections $id{29fda2fe-4134-4905-8682-aab074acfdb2}
- [ ] Manual Collections $id{c541949c-2e21-46c9-8089-a62fb6d043f6}
- [ ] Books Removal $id{6b577a16-ac19-4f95-bf84-47938d966adf}
- [ ] Access Restrictions $id{b6cf99a7-700b-46dd-9e75-5bc9fc7c4981}
- [ ] Metadata Manipulation $id{35652d34-5d76-4496-92e5-67617a3226ad}
- [ ] UiUx Improvements $id{9dd7c416-8919-40ed-a9a5-9503ad737e97}
- [ ] Others? $id{da6e44b4-312f-43b2-883d-3355a70464e8}
### Improved cover image storage, and acquisition.
### OPDS Support
- [ ] Manual Collections
- [ ] Books Removal
- [ ] Access Restrictions
- [ ] Metadata Manipulation
- [ ] UiUx Improvements
- [ ] Expanded book information view
- [ ] Improved Cover Image System
- [ ] OPDS Support
## Development