1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd278d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# cdc - a CardDAV Completer
+
+For use with [aerc](https://aerc-mail.org), [mutt](http://www.mutt.org), etc.
+
+## Installation
+
+Use `go get bnbl.io/cdc` to install. Next, simply create a configuration file at
+`$XDG_CONFIG_DIR/cdc/confg`, which by default is `$HOME/.config/cdc/config`.
+
+```toml
+endpoint = "https://carddav.example.com/dav/users/me@example.com/Default"
+username = "your-username@example.com"
+password-cmd = "pass your-username@example.com"
+```
+
+## Usage
+
+Search for contacts by running `cdc search-term`. cdc writes results in a format
+which is understood by aerc's and mutt's address book features. To configure
+aerc to use cdc for completion, add the following to ~/.config/aerc/aerc.conf:
+
+```
+[compose]
+address-book-cmd=cdc '%s'
+```