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 link is important'); +// text variable contains 'this is *important*' +```