branch: externals/calibre
commit c644d0761d9d178ba1e45f904fc2db178a8a36ee
Author: Kjartan Óli Ágústsson <[email protected]>
Commit: Kjartan Óli Ágústsson <[email protected]>
Slight improvement to README
* README: Add slightly more information to the README.
---
README | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/README b/README
index 68bc858c6f..e1c6597d65 100644
--- a/README
+++ b/README
@@ -1,8 +1,20 @@
Copyright (C) 2023 Kjartan Óli Águstsson
See the end of the file for license conditions.
-Calibre.el is an Emacs package for interacting with Calibre
-https://calibre-ebook.com/ libraries.
+Calibre.el is a package for interacting with Calibre
+(https://calibre-ebook.com/) libraries from Emacs. It's primary features
+include:
+- Easily switch between multiple libraries
+- List the contents of your library
+- Add and remove books from your library
+- Read your books in Emacs
+
+Calibre.el uses the built in SQLite support introduced in Emacs 29,
+and therefore requires an Emacs >= 29 compiled with SQLite support.
+Adding and removing books from a library requires a working calibredb
+executable, i.e. a Calibre installation. Even if Calibre is not
+installed you will still be able to view the contents of existing
+libraries.
This file is part of calibre.el.
