mirror of
https://github.com/th3r00t/pyShelf.git
synced 2026-04-28 01:59:35 -04:00
Updated Documentation and Readme
This commit is contained in:
41
README.md
vendored
41
README.md
vendored
@@ -1,20 +1,20 @@
|
|||||||
# pyShelf 0.8.0
|
# pyShelf 0.8.0
|
||||||
|
|
||||||
<p align="center"><b>Terminal based ebook server. Open source & Lightweight.</b></p>
|
<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>
|
||||||
|
|
||||||
|
|
||||||

|
### 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>
|
||||||
|
|
||||||
Follow or influence development @ <p align="center"><b>
|
|
||||||
<a href="https://discord.gg/H9TbNJS">Discord</a>
|
|
||||||
</b></p>
|
|
||||||
|
|
||||||
## 0.8.0 Patch Notes.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -26,7 +26,6 @@ Follow or influence development @ <p align="center"><b>
|
|||||||
- The Expanse
|
- The Expanse
|
||||||
* Download System
|
* Download System
|
||||||
* Automated Collections based on folder structure
|
* Automated Collections based on folder structure
|
||||||
* Expanded book information view
|
|
||||||
|
|
||||||
| Branch | Support | Feature set |
|
| Branch | Support | Feature set |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@@ -50,18 +49,14 @@ Follow or influence development @ <p align="center"><b>
|
|||||||
|
|
||||||
### Organizational tools.
|
### Organizational tools.
|
||||||
|
|
||||||
- [x] Automated Collections $id{29fda2fe-4134-4905-8682-aab074acfdb2}
|
- [ ] Manual Collections
|
||||||
- [ ] Manual Collections $id{c541949c-2e21-46c9-8089-a62fb6d043f6}
|
- [ ] Books Removal
|
||||||
- [ ] Books Removal $id{6b577a16-ac19-4f95-bf84-47938d966adf}
|
- [ ] Access Restrictions
|
||||||
- [ ] Access Restrictions $id{b6cf99a7-700b-46dd-9e75-5bc9fc7c4981}
|
- [ ] Metadata Manipulation
|
||||||
- [ ] Metadata Manipulation $id{35652d34-5d76-4496-92e5-67617a3226ad}
|
- [ ] UiUx Improvements
|
||||||
- [ ] UiUx Improvements $id{9dd7c416-8919-40ed-a9a5-9503ad737e97}
|
- [ ] Expanded book information view
|
||||||
- [ ] Others? $id{da6e44b4-312f-43b2-883d-3355a70464e8}
|
- [ ] Improved Cover Image System
|
||||||
|
- [ ] OPDS Support
|
||||||
### Improved cover image storage, and acquisition.
|
|
||||||
|
|
||||||
### OPDS Support
|
|
||||||
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user