aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 34 insertions, 25 deletions
diff --git a/README.md b/README.md
index 67e16b9..b824a18 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,46 @@
# 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_ keeps the overall design simple and generally useful.
+**sig**ned check**sum**s. Logging sigsums and not a more concrete type like
+TLS certificates keeps 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
+- Minimalistic design that simplifies log operations and usage ✔
+- Centralised log operations but distributed trust assumptions ✔
+- Discoverability of statements for the data of your choice ✔
A minimal statement encodes the following claim: the right data has a
certain cryptographic hash. You can add additional meaning to each
statement. For example, you may use a sigsum log to claim things like
-i) everyone get the same news articles, ii) software package X builds
-reproducibly, or iii) a list of key-value pairs are maintained with
-policy Y.
+(i) everyone get the same news articles,
+(ii) software package X builds reproducibly, or
+(iii) a list of key-value pairs are maintained with policy Y.
-Sigsum logging makes it reasonable to believe your claims by adding enough
-discoverability to verify them.
+Sigsum logging makes it reasonable to believe a claim by adding enough
+discoverability to facilitate verification.
-## Join the conversation
+Please refer to our
+[design document](https://git.sigsum.org/sigsum/tree/doc/design.md),
+[API specification](https://git.sigsum.org/sigsum/tree/doc/api.md), and
+[log prototype](https://git.sigsum.org/sigsum-log-go/tree/README.md)
+to learn more.
-### Chat
+## Services
+We self-host all services that are required to function as a project. Each
+service is operated on a best-effort level that is good enough for sigsum to
+rely upon. Please report any issues to the sigsum team via chat or email.
-Chat with users and developers using either IRC or Matrix. The rooms
-are bridged so it doesn't matter which one you choose.
+### Chat
+Chat with users and developers using IRC or Matrix. The rooms
+are bridged so it does not matter which one you choose.
- IRC: \#sigsum @ [OFTC.net](https://oftc.net/)
- Matrix: [#sigsum:matrix.org](https://app.element.io/#/room/#sigsum:matrix.org)
-### Email
+We also have open video/voice meets on Tuesdays at 1100 UTC, channel sigsum.
+- Jitsi: [meet.sigsum.org](https://meet.sigsum.org)
-Subscribe to the sigsum-general mailing list by sending an empty email
-to
+### Email
+Subscribe to the sigsum-general [mailing list](https://lists.sigsum.org) by
+sending an empty email to
sigsum-general+subscribe@lists.sigsum.org
@@ -45,15 +55,14 @@ empty email to
sigsum-general+help@lists.sigsum.org
+You can provide feedback, report issues, and submit patches by sending an email
+to sigsum-general@lists.sigsum.org.
-## Useful links
-- Go implementation of a sigsum log: [sigsum-log-go](https://git.sigsum.org/sigsum-log-go)
-- Python implementation of a sigsum witness: [sigsum-witness-py](https://git.sigsum.org/sigsum-witness-py)
-- Design and API specifications: [documentation](https://git.sigsum.org/sigsum/tree/doc)
-- Meeting minutes and persisted notes: [archive](https://git.sigsum.org/sigsum/tree/archive)
-- Website
- - https://www.sigsum.org/
- - https://er3n3jnvoyj2t37yngvzr35b6f4ch5mgzl3i6qlkvyhzmaxo62nlqmqd.onion/
+### Other
+- Source: [git.sigsum.org](https://git.sigsum.org)
+- Pads: [pad.sigsum.org](https://pad.sigsum.org)
+- Website: [www.sigsum.org](https://www.sigsum.org)
+- Onions: can be discovered for all services via Onion-Location.
## Sponsors
- [Mullvad VPN](https://mullvad.net/), financial sponsor