aboutsummaryrefslogtreecommitdiffstats
path: root/doc/overview.rst
diff options
context:
space:
mode:
authorTomasz Mieszkowski <tomasz.mieszkowski@ext.allegro.pl>2014-08-28 08:54:15 +0200
committerTomasz Mieszkowski <tomasz.mieszkowski@ext.allegro.pl>2014-08-28 08:54:15 +0200
commit60c073a6ed451cf91d9877a3305407756b9ffdce (patch)
tree955542ec282745e31d78d1b2b9515d8cebe67e78 /doc/overview.rst
downloadtipboard-60c073a6ed451cf91d9877a3305407756b9ffdce.tar.gz
tipboard-60c073a6ed451cf91d9877a3305407756b9ffdce.tar.bz2
tipboard-60c073a6ed451cf91d9877a3305407756b9ffdce.zip
Tipboard got open-sourced!1.4.0
Diffstat (limited to 'doc/overview.rst')
-rw-r--r--doc/overview.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/overview.rst b/doc/overview.rst
new file mode 100644
index 0000000..dc3f75f
--- /dev/null
+++ b/doc/overview.rst
@@ -0,0 +1,21 @@
+Overview
+--------
+
+Tipboard is a system for creating dashboards, written in JavaScript and Python.
+Its widgets ('tiles' in Tipboard's terminology) are completely separated from
+data sources, which provides great flexibility and relatively high degree of
+possible customizations.
+
+Because of its intended target (displaying various data and statistics in your
+office), it is optimized for larger screens.
+
+Similar projects: `Geckoboard <http://www.geckoboard.com/>`_,
+`Dashing <http://shopify.github.io/dashing/>`_.
+
+Project assumptions
+~~~~~~~~~~~~~~~~~~~
+
+#. Defining a dashboard layout (number of lines, columns, types of tiles etc.).
+#. Clear separation between tiles and data sources.
+#. Ability to create own tiles and scripts querying data sources (e.g. Jira, Bamboo, Confluence etc.).
+#. Feeding tiles via REST API.