From 8b4976e91efef93289db3fa60d10ec839fe41885 Mon Sep 17 00:00:00 2001
From: lumir-mrkva <lumir.mrkva@topmonks.com>
Date: Mon, 7 Sep 2015 16:07:31 +0200
Subject: [PATCH] readme

---
 README.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 676199f..674ef70 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
 # slackify-html
 
-convert html to slack markdown
+convert html to [slack markdown](https://slack.zendesk.com/hc/en-us/articles/202288908-Formatting-your-messages)
+
+example usage:
+```
+var slackify = require('slackify-html');
+
+var text = slackify('this <a href="http://github.com">link</a> is <b>important</b>');
+// text variable contains 'this <http://github.com|link> is *important*' 
+```