From a39252512badb62098bbcb75d0f0d7e6592717f9 Mon Sep 17 00:00:00 2001
From: Tim Mensinger <mensingertim@gmail.com>
Date: Tue, 10 Sep 2024 19:00:46 +0200
Subject: [PATCH] Update README

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 39 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 1c49824..2f2dccc 100644
--- a/README.md
+++ b/README.md
@@ -8,19 +8,53 @@ estimators were proposed. None of them is implemented in standard econometrics p
 
 ## Installation
 
-The package can be installed via conda. To do so, type the following in a terminal:
+The package can be installed via PyPI or via GitHub. To do so, type the following in a
+terminal:
 
-conda config --add channels conda-forge conda install skillmodels
+```console
+$ pip install skillmodels
+```
+
+or
+
+```console
+$ pip install git+https://github.com/OpenSourceEconomics/skillmodels.git
+```
 
 ## Documentation
 
 [The documentation is hosted at readthedocs](https://skillmodels.readthedocs.io/en/latest/)
 
-Alternatively, you can build it locally. After cloning the repository you can cd to the
-docs directory and type:
+## Developing
+
+We use [pixi](https://pixi.sh/latest/) for our local development environment. If you
+want to work with or extend the skillmodels code base you can run the tests using
+
+```console
+$ git clone https://github.com/OpenSourceEconomics/skillmodels.git
+$ pixi run tests
+```
 
+This will install the development environment and run the tests. You can run
+[mypy](https://mypy-lang.org/) using
+
+```console
+$ pixi run mypy
+```
+
+Before committing, install the pre-commit hooks using
+
+```console
+$ pre-commit install
 ```
-make html
+
+#### Documentation
+
+You can build the documentation locally. After cloning the repository you can cd to the
+docs directory and type:
+
+```console
+$ make html
 ```
 
 ## Citation