README.md in jekyll-plantastisch-1.0.0 vs README.md in jekyll-plantastisch-1.0.1
- old
+ new
@@ -1,7 +1,31 @@
-[](http://badge.fury.io/rb/jekyll-plantuml)
+[](https://badge.fury.io/rb/jekyll-plantastisch)
+# Jekyll Plantastisch
+> "Ein fantastischer PlantUML plugin!"
+
+`jekyll-plantastisch` is a PlantUML jekyll plugin with several
+distinguishable features:
+
+- It uses `<object>` html tag instead of `<img>` tag, when embedding
+ rendered diagrams on page.
+
+ This allows you to use interactive SVG
+ diagrams with links (see [PlantUML docs on this][plantuml_links]).
+
+- It requires you to put `@startuml` and `@enduml` tags into the
+ source of your diagram instead of forcibly inserting them.
+
+ This enables you to store the diagram's source in a completely
+ separate file in `_includes` directory and reuse it in several
+ places, while simply embedding it, when required:
+ ```jekyll
+ {% plantuml %}
+ {% include diagram.uml %}
+ {% endplantuml %}
+ ```
+
## Install Jekyll plugin
Install it first:
```
@@ -61,5 +85,6 @@
[First] - [Second]
@enduml
{% endplantuml %}
```
+[plantuml_links]: http://plantuml.com/link