📚 Add examples, images and options

README.md

@@ -6,6 +6,8 @@
 
 Adds admonitions parsing support to Remarkable
 
+<img src="assets/preview.png" width="680" />
+
 ## Installation
 
 With npm:
@@ -27,5 +29,29 @@ import Remarkable from 'remarkable';
 const md = new Remarkable();
 
 import admonitions from 'remarkable-admonitions';
-md.use(admonitions);
+md.use(admonitions({ icon: 'emoji' }));
+
+md.render(`
+:::caution
+Beware Ogre
+:::
+`);
+/* ->
+    <div class="admonition admonition-caution">
+      <div class="admonition-heading">
+        <h5><div class="admonition-icon">🔥</div> caution</h5>
+      </div>
+      <div class="admonition-content">
+        <p>Beware Ogre</p>
+      </div>
+    </div>
+*/
 ```
+
+## Options
+
+You may configure this plugin with the following options:
+
+| Option     | Default      | Description                                                                                                                                                                            |
+| ---------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`icon`** | `svg-inline` | Allows to use a different method to render admonition icons. By default it uses `svg-inline` with [Octicons](https://octicons.github.com) icons. Choose `emoji` to use Emojis instead. |