summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam Nystrom <sam@samnystrom.dev>2024-01-15 13:35:27 -0500
committerSam Nystrom <sam@samnystrom.dev>2024-01-15 13:35:27 -0500
commit2bdd00aa69b901e5230c9b8c24727011626ebeaa (patch)
tree27967a3ccc64ac477cb0336f4e61282e8ab832ff /README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a65dcc9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# cdb
+
+A reimplementation of D.J. Bernstein's [cdb tools](https://cr.yp.to/cdb.html)
+using [skalibs](https://skarnet.org/software/skalibs/).
+
+# Installation
+
+1. `make`
+2. `make install`
+
+# Usage
+
+See the man pages and the original [cdb page](https://cr.yp.to/cdb.html).