diff --git a/README.md b/README.md index 92e8a0e..0759b67 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,32 @@ Rationale: * Standard-compliant (we don't care about Microsoft Outlook) * Fully open-source -## Usage +## Setup + +### Golang + +hydroxide is implemented with Go. Head to [Golang website](https://golang.org) +for setup information. + +### Install and Setup + +Install hydroxide + +```shell +go get github.com/emersion/hydroxide/cmd/hydroxide +``` Your credentials will be stored on disk encrypted with a 32-byte random password. When configuring your client, you'll need this password. ```shell -go get github.com/emersion/hydroxide/cmd/hydroxide hydroxide auth ``` +## Usage + +hydroxide can be used in multiple modes. + ### CardDAV You must setup an HTTPS reverse proxy to forward requests to `hydroxide`.