Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
rm-dr committed Nov 17, 2024
1 parent ce42a39 commit cfe48ae
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
---

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 🚨
Copper is still very incomplete, and is nowhere near ready for daily use. \
Expand All @@ -39,14 +38,9 @@ PRs are very welcome, especially for the web ui!

## Features

- Supports all kinds of collections: audio, ebooks, photos, ad infinitum.
- Supports any kind of collection: 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>
Expand Down Expand Up @@ -75,10 +69,10 @@ 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.
A prebuilt docker image will be published once Copper reaches v1.

## User Documentation

Expand Down

0 comments on commit cfe48ae

Please sign in to comment.