readme

mrq-cz · Sep 7, 2015 · 8b4976e · 8b4976e
1 parent 6807ee6
commit 8b4976e
Showing 1 changed file with 9 additions and 1 deletion.
diff --git 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*' 
+```