From 25659ebba14044c7c0165f7cbac6f666da8bf8d5 Mon Sep 17 00:00:00 2001 From: Marcel van der Boom Date: Fri, 16 May 2014 15:24:32 +0200 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 4b595f9..e223e9a 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,25 @@ twister.el ========== An interface to the twister microblogging application from Emacs + + +Dependencies +------------ + +This library uses https://github.com/skeeto/elisp-json-rpc to issue +json rpc commands to the twister daemon. Make sure it is reachable by +your emacs load-path. + + +Usage +----- + +```el +(require 'twister) + +;; Configure an exsting username +(setq twister-user "yournick) + +;; Usage from code +(twister-post + "I have installed twister.el, and it works! -- https://github.com/mrvdb/twister.el #emacs #twister")