From 7b9d53050e54259b517b095e5f010c3e59d0f9e4 Mon Sep 17 00:00:00 2001 From: Keith Smiley Date: Tue, 8 Sep 2015 19:25:55 -0700 Subject: [PATCH] Update README --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a9a3c6a..13f0a42 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,21 @@ A simple script for querying contacts from the command line. -## [mutt](http://www.mutt.org/) integration +Usage: + +```sh +$ contacts query +NAME EMAIL +query@example.com First Last +``` + +## Installation + +```sh +brew install keith/formulae/contacts-cli +``` + +### [mutt](http://www.mutt.org/) integration Somewhere in your `muttrc`: @@ -10,3 +24,12 @@ Somewhere in your `muttrc`: set query_command="contacts '%s'" bind editor complete-query ``` + +##### Notes + +- This is a simplified replacement for the unmaintained + [contacts](http://www.gnufoo.org/contacts/contacts.html) +- This is distributed as a compiled executable rather than a swift + script to help with swift compatibility during new releases. +- If you have trouble running the script inside tmux see [this + issue](https://github.com/ChrisJohnsen/tmux-MacOSX-pasteboard/issues/43)