From 9ed419aaad11a2133d757d46b2d30e70e6462e3a Mon Sep 17 00:00:00 2001 From: lana-k Date: Fri, 9 Oct 2020 15:07:25 +0200 Subject: [PATCH] edit readme --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2ecf8e3..f575902 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ # sqliteviz -Interactive SQLite database visualiser using Plotly `react-chart-editor`. +**Note: This is a work-in-progress project.** -**Note: The project is in progress and not ready for using now.** +Sqliteviz is a single-page application for fully client-side visualisation of SQLite databases. +It's a kind of middleground between [Plotly Falcon][1] and [Redash][2]. +It is built on top of [react-chart-editor][3] and [sql.js][4] in [Vue.js][5]. + +## Features + +1. Ad-hoc and prepared visualisation of a SQLite database using flexibility + of SQL and richness of Plotly's `react-chart-editor` +2. Visualisation pallete, SQL and chart definitions, kept in local + storage with import/export +3. Integration-side provided pallete + +[1]: https://github.com/plotly/falcon +[2]: https://github.com/getredash/redash +[3]: https://github.com/plotly/react-chart-editor +[4]: https://github.com/sql-js/sql.js +[5]: https://github.com/vuejs/vue \ No newline at end of file