NotAShelf/pinakes
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions

docs: elaborate more on project features

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I6ede7c9bc529fe4948916f168ba1099b6a6a6964
This commit is contained in:
raf 2026-02-05 08:24:46 +03:00
commit cc88ecc5b7
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,9 +1,11 @@
# Pinakes
A media cataloging and library management system written in Rust. Pinakes
indexes files across configured directories, extracts metadata from audio,
video, document, and text files, and provides full-text search with tagging,
collections, and audit logging. It supports both SQLite and PostgreSQL backends.
Pinakes, named after the first known library cataloging system designed to be
the last library cataloging system you will ever need. Pinakes indexes files
across configured directories, extracts metadata from audio, video, document and
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
@ -33,7 +35,7 @@ your needs:
```bash
# Copy the sample config
$ cp pinakes.toml.example pinakes.toml
$ cp pinakes.example.toml pinakes.toml
```
Key settings: