diff --git a/README b/README index 05edd4989..b3b35b17e 100644 --- a/README +++ b/README @@ -1,2 +1,22 @@ The Chocolate project to implement sweet automatic encryption for webservers. +There are two portions to the Chocoate protocol. + +client-webserver/ contains code that can be run on any webserver (eventually, +email, XMPP and other SSL-securable servers too); it is used to automatically +request and install a CA-signed certificate for that server's public names. + +server-ca/ contains a reference implementation for CAs to receive requests for +certs, set challenges for the requesting servers to prove that they really +control the names, and issue certificates. + +Debian dependencies: + +build deps: +swig +protobuf-compiler +python-dev + +others: +gnutls-bin # for make cert requests +python-protobuf