Skip to content

Commit

Permalink
README polish
Browse files Browse the repository at this point in the history
  • Loading branch information
rm-dr committed Nov 17, 2024
1 parent ce5b532 commit 3cb0cef
Showing 1 changed file with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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>
Expand All @@ -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>
Expand All @@ -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

Expand Down

0 comments on commit 3cb0cef

Please sign in to comment.