diff --git a/README.md b/README.md index d7bed42..883e970 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,20 @@ function parse() { Install [foundation-cli](https://github.com/foundation/foundation-cli) to get the `foundation` command. +### In the browser / with browserify + +Include the dist/inky-browser.js script (``) in a page to convert any inky elements to html. Note that you'll want to include the script after any elements on the page. + +Alternatively, you can browserify Inky yourself. Here's a Hello World example that can be browserified with `browserify inky.js -o inky.bundle.js`: + +```js +//inky.js +var Inky = require('inky/lib/inky.js') +inky = new Inky() +convertedHtml = inky.releaseTheKraken('

Hello World!

') +console.log(convertedHtml) +``` + ## Plugin Settings - `src` (String): Glob of files to process. You don't need to supply this when using Inky with Gulp.