From 3cb0cefa4f9d8a92d2897cbab4daa93dac67eaef Mon Sep 17 00:00:00 2001
From: rm-dr <96270320+rm-dr@users.noreply.github.com>
Date: Sat, 16 Nov 2024 19:05:38 -0800
Subject: [PATCH] README polish

---
 README.md | 35 +++++++++++++++++++++++++++++------
 1 file changed, 29 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 24b15f0b..0f70be6c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
+[Paperless]: https://github.com/paperless-ngx/paperless-ngx
+[Calibre]: https://github.com/kovidgoyal/calibre
+[Beets]: https://github.com/beetbox/beets
+[Photoview]: https://github.com/photoview/photoview
+
+
 <p align="center">
   <a href="https://github.com/rm-dr/copper"><img src="./copperc/public/banner.svg" alt="Logo" width="60%"></a>
 </p>
@@ -14,18 +20,33 @@
 
 ---
 
+Copper is the universal digital library, aiming to replace ad-hoc solutions like [Paperless], [Calibre], and [Beets].
+It provides powerful data processing pipelines and universal item search, editing, and viewing
+
+## 🚨 Warning 🚨
+This project is still very incomplete, and is nowhere near ready for daily use. \
+This might change once the following projects are resolved:
+- [Backend v1](https://github.com/rm-dr/copper/milestone/1)
+- [Webui v1](https://github.com/rm-dr/copper/milestone/2)
+- [Data integrity](https://github.com/rm-dr/copper/milestone/4)
+
+PRs are very welcome, especially for the web ui!
+
 ## Features
 
-- Polished web ui
-  - Simple drag-and-drop uploading
-  - Graphical pipeline editor
+- Supports all kinds of collections: audio, ebooks, photos, ad infinitum.
+- Simple drag and drop uploads
+- Graphical data pipeline editor
 - Replaces
   - [Paperless](https://github.com/paperless-ngx/paperless-ngx) (documents)
   - [Calibre](https://github.com/kovidgoyal/calibre) (ebooks)
   - [Beets](https://github.com/beetbox/beets) (music)
   - [Photoview](https://github.com/photoview/photoview) (photos)
+- <span style="color:grey">~~Edit items in bulk~~ (planned)</span>
+- <span style="color:grey">~~Simple backup~~ (planned)</span>
+- <span style="color:grey">~~Powerful export pipelines~~ (planned)</span>
 - <span style="color:grey">~~Scriptable api~~ (planned)</span>
-- <span style="color:grey">~~Simple export & backup~~ (planned)</span>
+- <span style="color:grey">~~Flexible data export~~ (planned)</span>
 - <span style="color:grey">~~Email notifications~~ (planned)</span>
 - <span style="color:grey">~~Automatic ingestion~~ (planned)</span>
 - <span style="color:grey">~~Fast & powerful search~~ (planned)</span>
@@ -49,12 +70,14 @@ Copper is designed to be run in docker. To get started, to the following:
 - Download the contents of [`./dist`](./dist/)
 - `cd dist`
 - `docker compose up -d`
-- Read `./dist/docker-compose.yml`
+- Read `./dist/docker-compose.yml` \
   If you want to run the stack manually, see [`CONTRIBUTING.md`](./CONTRIBUTING.md).
 
+A prebuild docker image will be published once Copper reaches v1.
+
 ## User Documentation
 
-Has yet to be written. It will likely be embedded in copper's web ui.
+Has yet to be written. It will likely be embedded in Copper's web ui.
 
 ## Bugs and Feature requests