From ee9f8d007f35996ccda6fb88ae524551bf4b126e Mon Sep 17 00:00:00 2001
From: Adam Ormondroyd <52655393+AdamOrmondroyd@users.noreply.github.com>
Date: Thu, 25 Jan 2024 15:03:37 +0000
Subject: [PATCH] update readme (#14)

---
 README.md | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 27f4ba8..a2d4c06 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,23 @@
 # Flex-Knot
 
-This repo contains flex-knots and associated likelihoods used in my `toy_sine` project, and likelihoods associated with them.
+This repo contains flex-knots and associated likelihoods
+
+I initially created this for the `toy_sine` project, but it is also used for the
+primordial matter power spectrum $\mathcal P_\mathcal R(k)$, and the dark energy
+equation of state $w(a)$.
 
-If I get this right, I should be able to use this to investigate $w(z)$ and so on.
 
 To pip install:
 
-    pip install git+ssh://github.com/Ormorod/flexknot@main
+    pip install git+ssh://github.com/adamormondroyd/flexknot@main
+
+To install locally:
+    
+    gh repo clone adamormondroyd/flexknot # (or ssh or https)
+    cd flexknot
+    pip install -e .
+
+Or to get all test dependencies:
+
+    pip install -e '.[dev]'
+