Merge pull request #16 from Hexanet/better-readme

nclsHart · web-flow · commit d3e1f4b541fc · 2018-04-19T15:19:09.000+02:00
:doc: Better README with example
diff --git a/README.md b/README.md
@@ -2,7 +2,33 @@
 
 [![Build Status](https://travis-ci.org/Hexanet/swiftmailer-image-embed.svg)](https://travis-ci.org/Hexanet/swiftmailer-image-embed) [![Total Downloads](https://poser.pugx.org/hexanet/swiftmailer-image-embed/downloads.png)](https://packagist.org/packages/hexanet/swiftmailer-image-embed) [![Latest Stable Version](https://poser.pugx.org/hexanet/swiftmailer-image-embed/v/stable.png)](https://packagist.org/packages/hexanet/swiftmailer-image-embed)
 
-Swiftmailer plugin to automatically embed images into message.
+Swiftmailer plugin to automatically embed images into message by using CID (Content-ID).
+
+See https://swiftmailer.symfony.com/docs/messages.html#embedding-inline-media-files for more informations.
+
+Example: 
+
+```html
+<html>
+    <head></head>
+    <body>
+        <p>some text</p>
+        <img src="images/swiftmailer_rocks.png" alt="placeholder">
+    </body>
+</html>
+```
+
+With the plugin the following email will be generated: 
+
+```html
+<html>
+    <head></head>
+    <body>
+        <p>some text</p>
+        <img src="cid:1eda5ca8666e64003917d06b34bbd2f7@swift.generated" alt="placeholder">
+    </body>
+</html>
+```
 
 ## Installation
 
@@ -23,15 +49,16 @@ $mailer->registerPlugin(new ImageEmbedPlugin());
 or for symfony in your services.yaml:
 ```yml
 Hexanet\Swiftmailer\ImageEmbedPlugin:
-    arguments: ['%kernel.root_dir%/../web/']
+    arguments:
+        - '%kernel.root_dir%/../web/'
     tags: [swiftmailer.default.plugin]
 ```
 
 The arguments are optional.
 
 ## Credits
 
-Developed by [Hexanet](http://www.hexanet.fr/).
+Developed by [Hexanet](https://www.hexanet.fr/).
 
 ## License
 
