diff --git a/README.md b/README.md index 66b7cdd..7f91230 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# commonmark-picture-extension - Adds support of picture tags to CommonMark PHP implementation +# n0sz/commonmark-picture-extension +This library adds support of `` tags to [league/commonmark](https://github.com/thephpleague/commonmark) +# Installation +This project can be install via composer: +``` +composer require n0sz/commonmark-picture-extension +``` +# Usage +```php +use League\CommonMark\Environment\Environment; +use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension; +use N0sz\CommonMark\Picture\PictureExtension; + +$environment = new Environment(); +$environment->addExtension(new CommonMarkCoreExtension()); +$environment->addExtension(new PictureExtension()); +``` +# Syntax +Code: +```txt +[[[ ++ img_1 {media:"(min-width:650px)"} ++ img_2 {media:"(min-width:465px)"} +- img_3 +]]] +``` +Result: +```html + + + + + +```