Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
phildenhoff authored May 14, 2024
1 parent f513db7 commit 515e779
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

Manage your ebook library with Citadel. Backwards compatible with Calibre.

https://github.com/every-day-things/citadel/assets/17505728/84a0c9dd-f14e-411a-8947-1d599f3ad85a
https://github.com/every-day-things/citadel/assets/17505728/a3879896-8404-4333-98cb-5e1e0060b42e

**[Live Demo](https://citadel-demo.everydaythings.software/)** — use an online read-only example library to try out Citadel before installing. The web UI is slightly different from the desktop UI, and not all features work. All books are copyright free and available courtesy of Standard Ebooks.

**Citadel is very early software, and as such is full of bugs and lacking features.**
**Citadel is early software; it is likely full of bugs and lacking features.**

## Project goals

Expand All @@ -16,19 +14,22 @@ https://github.com/every-day-things/citadel/assets/17505728/84a0c9dd-f14e-411a-8

### Non-goals

- **Ebook reader**: Citadel is not an ebook reader. There are many other tools that do a much better job than we could do.
- **Ebook reader**: Citadel is not an ebook reader. There are already excellent ereader apps: Citadel will open your files in your default apps.
- **...or editor**: If you're editing ebook _content_ (not metadata like titles), Citadel will not be a replacement for you.
- **100% feature parity**: Primarily around Plugins, but there are some advanced features of Calibre we'll likely never build.

## Downloading

> [!WARNING]
> Citadel is _very_ early in development. It will crash. A lot. It may corrupt your ebook library.
> Citadel is _very_ early in development. It may crash, or be missing basic features. It may corrupt your ebook library.
>
> **Back up your Calibre library regularly if you use Citadel on it.**
Citadel builds are available from [GitHub actions](https://github.com/every-day-things/citadel/actions/runs/7536243753).
There is no guarantee these builds work.
(Semi-) stable builds are available in [Releases](https://github.com/every-day-things/citadel/releases).

Development builds are available from [GitHub actions](https://github.com/every-day-things/citadel/actions/workflows/build.yml).

Please report any issues or crashes you experience while using any version of Citadel!

## Developing

Expand Down

0 comments on commit 515e779

Please sign in to comment.