Tipboard got open-sourced!1.4.0

1 files changed, 34 insertions, 0 deletions

diff --git a/doc/tile__listing.rst b/doc/tile__listing.rst
new file mode 100644
index 0000000..dbe2516
--- /dev/null
+++ b/doc/tile__listing.rst
@@ -0,0 +1,34 @@
+===========
+``listing``
+===========
+
+.. image:: img/smaller/listing.png
+
+**Description**
+
+Very simple tile for displaying list of entries (up to seven) of arbitrary
+content. For more sophisticated needs there is a ``fancy_listing`` tile.
+
+**Content**
+
+::
+
+  data = {"items": ["<entry1>", "<entry2>", ..., "<entry7>"]}
+
+where:
+
+.. describe:: items
+
+   List of items (entries) to display.
+
+Example::
+
+  curl http://localhost:7272/api/v0.1/<api_key>/push
+       -X POST
+       -d "tile=listing"
+       -d "key=<tile_id>"
+       -d "data={"items": ["Leader: 5", "Product Owner: 0", "Scrum Master: 3", "Developer: 0"]}"
+
+**Configuration**
+
+This tile does not offer any configuration options.