From d4ba998bb268f584909a6361b9656b0dcd267493 Mon Sep 17 00:00:00 2001 From: emersion Date: Sun, 3 Dec 2017 12:32:33 +0100 Subject: [PATCH] Update README --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fe59126..0f9510d 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,38 @@ # hydroxide -A third-party, open-source ProtonMail CardDAV bridge. For power users only, -designed to run on a server. +A third-party, open-source ProtonMail bridge. For power users only, designed to +run on a server. + +hydroxide supports CardDAV and SMTP. ## Usage Your credentials will be stored on disk encrypted with a 32-byte random -password. When configuring your CardDAV client, you'll need this password. -You must setup an HTTPS reverse proxy to forward requests to `hydroxide`. +password. When configuring your client, you'll need this password. ```shell go get github.com/emersion/hydroxide hydroxide auth +``` + +### CardDAV + +You must setup an HTTPS reverse proxy to forward requests to `hydroxide`. + +```shell hydroxide carddav ``` Tested on GNOME (Evolution) and Android (DAVDroid). +### SMTP + +For now, it only supports unencrypted local connections. + +```shell +hydroxide smtp +``` + ## License MIT