From 219cf2e44c2b50e3738cb407ec6037fd9174ba26 Mon Sep 17 00:00:00 2001 From: lew <82828093+Llywelwyn@users.noreply.github.com> Date: Fri, 19 Dec 2025 01:24:08 +0000 Subject: [PATCH] docs(README): introductory paragraphs --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 1b30f11..3d39640 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,23 @@
+`pda!` is a command-line key-value store tool with: +- [templates](https://github.com/Llywelwyn/pda#templates), +- search and filtering with [globs](https://github.com/Llywelwyn/pda#globs), +- Git-backed [version control](https://github.com/Llywelwyn/pda#git), +- plaintext exports in multiple formats, +- [secrets](https://github.com/Llywelwyn/pda#secrets), +- support for [binary data](https://github.com/Llywelwyn/pda#binary), +- [time-to-live](https://github.com/Llywelwyn/pda#ttl) support, + +and more, written in pure Go, and inspired by [skate](https://github.com/charmbracelet/skate) and [nb](https://github.com/xwmx/nb). + + + +`pda` canonically stores key-value pairs in [badger](https://github.com/dgraph-io/badger) databases for the sake of speed, but supports exporting everything out to a handful of different plaintext formats too, including but not limited to [CSV](https://en.wikipedia.org/wiki/Comma-separated_values), [TSV](https://en.wikipedia.org/wiki/Tab-separated_values), [newline-delimited JSON](https://en.wikipedia.org/wiki/JSON_streaming#Newline-delimited_JSON), and [Markdown](https://en.wikipedia.org/wiki/Markdown) and [HTML](https://en.wikipedia.org/wiki/HTML_element#Tables) tables. `pda` uses newline-delimited JSON for version control; a full snapshot of every existing key-value pair across all stores can be manually requested with the snapshot command, or auto-commit can be enabled in the config to automatically generate a descriptive commit for every change made. + + +