diff --git a/README.md b/README.md index c9a063ce0ce7a39aa47abdb70a9ace4f674760aa..b4a8c5d892f82057376f8dd47654ba390fde5676 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ # markdown-it-imsize [](https://travis-ci.org/tatsy/markdown-it-imsize) +[](https://www.npmjs.org/package/markdown-it-imsize) [](https://coveralls.io/r/tatsy/markdown-it-imsize) > markdown-it plugin for size-specified image markups. + +## Usage + +#### Enable plugin + +```js +var md = require('markdown-it')({ + html: true, + linkify: true, + typography: true +}).use(require('markdown-it-imsize'); // <-- this use(package_name) is required +``` + +#### Example + +```md + +``` + +is interpreted as + +```html +<p><img src="image.png" width="100" height="200"></p> +```