From a857f24998df5a73af47dbec27091d470f27543c Mon Sep 17 00:00:00 2001
From: Sven Augustin <sven.augustin@psi.ch>
Date: Sat, 28 May 2022 13:48:01 +0200
Subject: [PATCH] something to read

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 268649e..d514eb3 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # stand
 
+An editable, filterable and sortable spreadsheet (via [Ag Grid](https://github.com/PablocFonseca/streamlit-aggrid/)) webapp (via [Streamlit](https://streamlit.io/)) with REST API (via [CherryPy](https://cherrypy.dev/)) using [Pandas](https://pandas.pydata.org/) [DataFrames](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html).
+
 ## Setup
 
 ```bash
@@ -14,3 +16,23 @@ conda install conda-forge::python-dotenv pyyaml simplejson # aggrid deps
 
 pip install streamlit-aggrid
 ```
+
+## Start the webapp
+
+```bash
+$ ./stand.sh
+```
+
+## Use the python client
+
+```python
+from client import Client
+
+c = Client()
+
+c.add_row(a=1, b=2.3, c="three")
+c.add_row(a=2, b=3.4, c="four", x=123)
+
+c.clear()
+```
+