[tor-commits] [lego/develop] Update README in xml plugin

[hiro at torproject.org]

commit 610beb061c5cdad96a1a85db7b2cce5038858432
Author: hiro <hiro at torproject.org>
Date:   Wed Sep 4 15:22:08 2019 +0200

    Update README in xml plugin
---
 packages/xml-to-html/README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/packages/xml-to-html/README.md b/packages/xml-to-html/README.md
index 65c4c89..6ba9f74 100644
--- a/packages/xml-to-html/README.md
+++ b/packages/xml-to-html/README.md
@@ -1 +1,26 @@
 # Lektor XML atom feed to html
+
+This plugin enables a way to import an atom xml feed into [Lektor](http://getlektor.com) static website directly in the template.
+
+## Configuration
+
+In the template where you would like to import the feed add the following:
+
+```
+{{ render_stream("https://blog.example.org/rss.xml")|safe }}
+
+```
+
+The plugin will add the following to your built html:
+
+```
+<div class="row">
+  <h3>
+    <a href="https://www.example.org/posts/this-is-a-post-link">
+      This is a post title
+    </a>
+  </h3>
+</div>
+```
+
+For each entry in your feed.