diff --git a/README.md b/README.md index 83315b9..6d8eedf 100644 --- a/README.md +++ b/README.md @@ -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: