From f127e77b0a4db8c0c99a3f86f8326c088880a1b0 Mon Sep 17 00:00:00 2001
From: FrederikBaerentsen <frederik+gitea@baerentsen.net>
Date: Tue, 7 Jun 2022 16:51:19 +0200
Subject: [PATCH] Started new README with installation instructions

---
 README.md     | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md.old | 44 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 103 insertions(+)
 create mode 100644 README.md
 create mode 100644 README.md.old

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c9662ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# ComicOPDS
+
+ComicOPDS is a lightweight OPDS server written in Python and Flask that allows you to browse your cbz files using OPDS.
+
+## Getting Started
+
+The easiest way to get started is to clone the git reposetory, build the docker image and run docker-compose.
+
+Alternativly you can clone the repo and start the flask server using the main file. This requires a bit of configuration.
+
+### Docker
+
+#### Prerequisites
+
+- Docker
+- Docker-compose
+
+#### Installing
+
+First clone the git repo.
+
+    git clone https://gitea.baerentsen.space/ComicOPDS
+
+Then go to the folder
+
+    cd ComicOPDS
+
+Next build the image
+
+    docker build . -t comicopds
+
+Adjust the docker-compose file:
+
+    <add docker compose example with config options and drive mapping>
+
+Run docker-compose
+
+    docker-compose up
+
+### Manual Install
+
+To manually install the flask server you need to install the python requirements.
+
+#### Prerequisites
+
+- Python3.x
+
+#### Installing
+
+    python3 -m pip install -r requirements.txt
+
+#### Change configs
+
+In the `config.py` file you need to change like 4 from `"/library"` to your comic library. This has only been tested on Debian.
+
+#### Running
+
+    python3 main.py
+
diff --git a/README.md.old b/README.md.old
new file mode 100644
index 0000000..d121666
--- /dev/null
+++ b/README.md.old
@@ -0,0 +1,44 @@
+# teenyopds
+
+Small flask based opds catalog designed to serve a directory via OPDS, it has currently only been verified to work with KyBook 3 on iOS but should work with other OPDS compatible ereaders.
+
+## Quickstart
+
+`docker build . -t teenyopds`
+
+`docker run -p 5000:5000 -v /path/to/content:/library teenyopds`
+
+Navigate to `http://localhost:5000/catalog` to view opds catalog
+
+## Configuration
+
+The following environment variables can be set
+
+`CONTENT_BASE_DIR` to server an alternative directory
+
+`TEENYOPDS_ADMIN_PASSWORD` password for content and catalog, if not set the content and catalog will be available publicly
+
+## Other endpoints
+
+`/heathz` will return "ok" if the service is up and running
+
+## Supported Readers
+
+Any reader that supports OPDS should work, however the following have been verified to work/not work
+
+| App                                                                                                   | Android | iOS |
+| ----------------------------------------------------------------------------------------------------- | ------- | --- |
+| [KyBook 3](http://kybook-reader.com/)                                                                 | -       | ✔️  |
+| Aldiko Next                                                                                           | ❌      | ✔️  |
+| [PocketBook](https://pocketbook.ch/en-ch/app)                                                         | -       | ✔️  |
+| [Moon+ Reader](https://play.google.com/store/apps/details?id=com.flyersoft.moonreader&hl=en_US&gl=US) | ✔️      | -   |
+
+## TODO
+
+Implement simple searching
+
+Metadata lookup based either filename or some type of metadata file populated by the user, one idea is to just have the users put the ISBN in the filename
+
+Support basic auth
+
+I believe OPDS supports content compression however kybook doesn't like it so it's not implemented