From 5530e3f86dbcd0059a84ceb0827de42ce019de47 Mon Sep 17 00:00:00 2001
From: pswain <peter.swain@ed.ac.uk>
Date: Tue, 23 Jan 2024 18:41:45 +0000
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index 823e4ae..bfb707d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
 # Wela
+
+A package to analyse output from aliby.
+
+Wela uses the h5 files created by aliby to create a dataframe and save this dataframe as a text file. 
+
+With Wela, you can use a Gaussian process to generate single-cell growth rates.
+
+Wela includes plotting routines for common tasks, such as kymographs and plotting single lineages for one ALCATRAS trap.
+
+## Installing
+
+Clone the gitlab repository and install with poetry.
+
+## Getting started
+
+There are example scripts in `wela/examples`.
+
+Use
+
+- `create_tsv.py` to see how to generate a tsv file of the data
+- `plot_kymograph.py` to see how to generate a kymograph
+- `run_gr.py` to learn how to estimate single-cell growth rates.
+
-- 
GitLab