From 1f67ae0d4be87608e2c1aeefab62cde9c57a46fc Mon Sep 17 00:00:00 2001
From: Bennett Goble <signal@lindenlab.com>
Date: Thu, 16 Mar 2023 12:55:43 -0700
Subject: [PATCH] Add basic development instructions

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

diff --git a/README.md b/README.md
index c9c694d..829b739 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 
 Official python serialization library for [Linden Lab Structured Data (LLSD)][llsd].
 
-# Use
+## Use
 
 Install **llsd** with pip:
 ```
@@ -36,5 +36,27 @@ data = llsd.parse(data_binary)
 # >>> {'foo: 'bar'}
 ```
 
+## Develop
+
+Requirements:
+
+- [pre-commit](https://pre-commit.com/)
+
+Set up a venv and install development dependencies:
+```
+python3 -m venv .venv
+. .venv/bin/activate
+pip install .[dev]
+```
+
+Run tests:
+```
+pytest
+```
+
+### Benchmarks
+
+Benchmarks from commits to `main` are published [here](https://secondlife.github.io/python-llsd/dev/bench/).
+
 [llsd]: https://wiki.secondlife.com/wiki/LLSD
 [llbase]: https://pypi.org/project/llbase/