Skip to content

Commit 511282c

Browse files
Minor updates to README and adding dir for wiki_images
1 parent cf6bda0 commit 511282c

3 files changed

Lines changed: 10 additions & 62 deletions

File tree

README.md

Lines changed: 9 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ Calibre-Web Automated aims to be an all-in-one solution, combining the modern li
6464
![Calibre-Web Automated Example Homepage](README_images/CWA-Homepage.png)
6565
<p style="text-align:center;"><i>CWA allows you to keep your ebook library accessible & organised and looks good while doing it</i> 😎🦚</p>
6666

67+
## Join our Community! ❤️
68+
69+
- I want to say a **big thanks** 🙏 to all the members of this community that have taken the time to participate in the testing and development of this project and we encourage anyone who would like to to contribute in some way. Anyone of any level is welcome and every little helps!
70+
- **For anyone that wish to contribute to this project in some way**, please reach out on our Discord Server and see how you can best get involved:\
71+
\
72+
[![](https://dcbadge.limes.pink/api/server/https://discord.gg/EjgSeek94R)](https://discord.gg/EjgSeek94R)
73+
74+
- Or alternativly make your own companion project, come hang out and or come get help if you're facing issues :)
75+
6776
## **_Features:_**
6877

6978
### CWA supports all Stock CW Features:
@@ -191,26 +200,6 @@ Calibre-Web Automated aims to be an all-in-one solution, combining the modern li
191200

192201
![Calibre-Web Automated](README_images/cwa-bulk-editting-diagram.png "Calibre-Web Automated Bulk Editing & Bulk Deletion")
193202

194-
<!-- - **Simple CLI Tools** for manual fixes, conversions, enforcements, history viewing ect. 👨‍💻
195-
196-
- Built-in command-line tools now also exist for:
197-
- Viewing the Edit History of your Library files _(detailed above)_
198-
- Listing all of the books currently in your Library with their current Book IDs
199-
- **Manually enforcing the covers & metadata for ALL BOOKS** in your library using the `cover-enforcer -all` command from within the container **(RECOMMENDED WITH FIRST TIME USE)**
200-
- Manually Enforcing the Covers & Metadata for any individual books by using the following command
201-
- `cover-enforcer --dir <path-to-folder-containing-the-books-epub-here>`
202-
- Full usage and documentation for all new CLI Commands can be found [here](#the-cover-enforcer-cli-tool)
203-
![CWA Database](README_images/cwa-db-diagram.png "CWA 1.2.0 Cover Database Diagram") -->
204-
205-
206-
## UNDER ACTIVE DEVELOPMENT ⚠️
207-
208-
- Please be aware that while CWA currently works for most people, it is still under active development and that bugs and unexpected behaviours can occur while we work and the code base matures
209-
- I want to say a big thanks 🙏 to the members of this community that have taken the time to participate in the testing and development of this project and we encourage anyone who would like to to contribute in some way. Anyone of any level is welcome and every little helps!
210-
- For any others that wish to contribute to this project in some way, please reach out on our Discord Server and see how you can best get involved:\
211-
\
212-
[![](https://dcbadge.limes.pink/api/server/https://discord.gg/EjgSeek94R)](https://discord.gg/EjgSeek94R)
213-
214203
# Features Currently Under Active Development and on our Roadmap 🏗️🛣️
215204

216205
#### High Priority 🚨
@@ -338,48 +327,6 @@ And just like that, Calibre-Web Automated should be up and running! **HOWEVER**
338327

339328
CWA now includes built-in KOReader syncing functionality, allowing you to sync your reading progress across devices using KOReader. This feature provides a modern, secure alternative to traditional KOReader sync servers. Navigate to `http://your-cwa-instance:8083/kosync` in your browser where you'll find download links and installation instructions for the CWA KOReader plugin.
340329

341-
<!-- # CWA CLI Tools 🧑‍💻
342-
343-
## The Cover-Enforcer CLI Tool
344-
345-
```
346-
usage: cover-enforcer [-h] [--log LOG] [--dir DIR] [-all] [-list] [-history] [-paths] [-v]
347-
348-
Upon receiving a log, valid directory or an "-all" flag, this script will enforce the covers and metadata of the corresponding books, making sure that each are correctly stored in
349-
both the epubs themselves and the user's Calibre Library. Additionally, if an epub happens to be in EPUB 2 format, it will also be automatically upgraded to EPUB 3.
350-
351-
options:
352-
-h, --help show this help message and exit
353-
--log LOG Will enforce the covers and metadata of the books in the given log file.
354-
--dir DIR Will enforce the covers and metadata of the books in the given directory.
355-
-all Will enforce covers & metadata for ALL books currently in your calibre-library-dir
356-
-list, -l List all books in your calibre-library-dir
357-
-history Display a history of all enforcements ever carried out on your machine (not yet implemented)
358-
-paths, -p Use with '-history' flag to display stored paths of all epubs in enforcement database
359-
-v, --verbose Use with history to display entire enforcement history instead of only the most recent 10 entries
360-
```
361-
362-
![CWA Cover-Enforcer History Usage](README_images/cwa-db-diagram.png)
363-
364-
## The Convert-Library Tool
365-
366-
```
367-
usage: convert-library [-h] [--replace] [--keep] [-setup]
368-
369-
Made for the purpose of converting ebooks in a calibre library not in epub format, to epub format
370-
371-
options:
372-
-h, --help show this help message and exit
373-
--replace, -r Replaces the old library with the new one
374-
--keep, -k Creates a new epub library with the old one but stores the old files in /config/processed_books
375-
-setup Indicates to the function whether or not it's being ran from the setup script or manually (DO NOT USE MANUALLY)
376-
```
377-
378-
## Checking the Monitoring Services are working correctly
379-
380-
- Simply run the following command from within the container: `cwa-check`
381-
- If all 3 services come back as green and running they are working properly, otherwise there may be problems with your configuration/install -->
382-
383330
---
384331
## For Developers - Building Custom Docker Image
385332
If you want to contribute to this project, you can build a local version with your changes by running `build.sh` in the repository.

cwa-wiki

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit 400843f21ce9a85183d03031ac86b20e51c8b3be

wiki_images/cwa-login-page.png

120 KB
Loading

0 commit comments

Comments
 (0)