docs: elaborate more on project features
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I6ede7c9bc529fe4948916f168ba1099b6a6a6964
This commit is contained in:
parent
f16046022b
commit
cc88ecc5b7
1 changed files with 7 additions and 5 deletions
12
README.md
12
README.md
|
|
@ -1,9 +1,11 @@
|
||||||
# Pinakes
|
# Pinakes
|
||||||
|
|
||||||
A media cataloging and library management system written in Rust. Pinakes
|
Pinakes, named after the first known library cataloging system designed to be
|
||||||
indexes files across configured directories, extracts metadata from audio,
|
the last library cataloging system you will ever need. Pinakes indexes files
|
||||||
video, document, and text files, and provides full-text search with tagging,
|
across configured directories, extracts metadata from audio, video, document and
|
||||||
collections, and audit logging. It supports both SQLite and PostgreSQL backends.
|
text files, and provides full-text search with tagging, collections, roles,
|
||||||
|
audit logging and more. It supports both SQlite (for easy bootstrapping) and
|
||||||
|
PostgreSQL (production deployments) as available database backends.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
|
|
@ -33,7 +35,7 @@ your needs:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Copy the sample config
|
# Copy the sample config
|
||||||
$ cp pinakes.toml.example pinakes.toml
|
$ cp pinakes.example.toml pinakes.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
Key settings:
|
Key settings:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue