From 7a7a7f7c3f3b7a91470801690c13a3334b7c40c2 Mon Sep 17 00:00:00 2001
From: James Stevenson <james.stevenson@nationwidechildrens.org>
Date: Tue, 16 Jan 2024 15:15:03 -0500
Subject: [PATCH] update readme

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d9b0f29..bc0246c 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ from chainlifter.lifter import ChainLifter
 ch = ChainLifter("hg38", "hg19")
 ```
 
-Call ``convert_coordinate``:
+Call ``convert_coordinate()``:
 
 ```python3
 ch.convert_coordinate("chr7", 140453136, "+")
@@ -27,7 +27,13 @@ Create a virtual environment and install developer dependencies:
 ```shell
 python3 -m virtualenv venv
 source venv/bin/activate
-python3 -m pip install -e '.[dev]'
+python3 -m pip install -e '.[dev,tests]'
+```
+
+Be sure to install pre-commit hooks:
+
+```shell
+pre-commit install
 ```
 
 This installs Python code as editable, but after any changes to Rust code, ``maturin develop`` must be run:
@@ -35,3 +41,9 @@ This installs Python code as editable, but after any changes to Rust code, ``mat
 ```shell
 maturin develop
 ```
+
+Run tests with `pytest`:
+
+```shell
+pytest
+```