aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md33
1 files changed, 31 insertions, 2 deletions
diff --git a/README.md b/README.md
index 892c655..6a727f3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
-# sigsum
-Documentation
+# The Sigsum Project
+Sigsum is a free and open source project that brings transparency logging to
+**sig**ned check**sum**s. Logging _sigsums_ and not a more concrete type like
+_certificates_ keep the overall design simple and generally useful.
+
+✔ Minimalistic design that simplifies log operations and usage\
+✔ Centralised log operations but distributed trust assumptions\
+✔ Discoverability of statements for data of your choice
+
+A minimal statement encodes the following claim: the data has cryptographic hash
+X. You can add additional meaning to each statement. For example, you may use
+a sigsum log to claim that
+ _everyone gets the same news articles_,
+ _software package X builds reproducibly_, or
+ _a list of key-value pairs is maintained with policy Y_.
+
+Sigsum logging makes it reasonable to believe your claims by adding enough
+discoverability to verify them.
+
+## Join the conversation
+- IRC: \#sigsum @ oftc.net
+- Matrix: [#sigsum:matrix.org](https://app.element.io/#/room/#sigsum:matrix.org)
+
+## Useful links
+- Go implementation of a sigsum log: [sigsum-log-go](https://github.com/sigsum/sigsum-log-go)
+- Python implementation of a sigsum witness: [sigsum-witness-py](https://github.com/sigsum/sigsum-witness-py)
+- Design and API specifications: [documentation](https://github.com/sigsum/sigsum/tree/main/doc)
+- Meeting minutes and persisted notes: [archive](https://github.com/sigsum/sigsum/tree/main/archive)
+- Website
+ - https://www.sigsum.org
+ - https://er3n3jnvoyj2t37yngvzr35b6f4ch5mgzl3i6qlkvyhzmaxo62nlqmqd.onion