summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordu.net>2016-12-05 01:22:27 +0100
committerLinus Nordberg <linus@nordu.net>2016-12-05 01:22:27 +0100
commit8127a1f74768ef58583628128d45ef45313a862d (patch)
tree3aad00267f82a2eef423db694975ab808c84b109 /README.md
parente9a40cb93e086e649bd1293b4a2be70f3a45451c (diff)
Update README.md with high level features description.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index bdfde42..bdbe5c9 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,23 @@
catlfish is a Certificate Transparency log server (RFC 6962).
+The catlfish software has the following properties:
+
+- Distributed, for fault tolerance under high load
+
+- Layered software design with a generic append-only database below
+ and public protocol on top, making it useful for buildling other
+ transparency systems as well
+
+- Cross-organisational operations, enabling scaling beyond what can be
+ achieved by a single organisation
+
+- Append-only database backend specially designed for this purpose
+
+- HSM support, for keeping sensitive keys off general purpose computers
+
+- Dockerised, for a snazzy deployment option
+
# Requirements
In order to compile catlfish, the following software packages are