From 593cdcc559a5f7a389f9fffcddad5fc151ab6d20 Mon Sep 17 00:00:00 2001
From: tomvanmele <tom.v.mele@gmail.com>
Date: Wed, 28 Feb 2024 22:39:54 +0100
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
index 3d39aec..2e89630 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
 # Constrained form finding using Dynamic Relaxation
+
+This package provides equilibrium solvers and constraints
+for constrained form finding using the "dynamic relaxation" method.
+
+The solvers can be used through the `compas_dr` paclage directly,
+or through COMPAS FormFinder, which is a form finding tool with a GUI
+combining various different form finding approaches.
+
+## Installation
+
+Stable releases can be installed from PyPI.
+
+```bash
+pip install compas_dr
+```
+
+To install the latest development version, do:
+
+```bash
+git clone https://github.com/blockresearchgroup/compas_dr.git
+cd compas_dr
+pip install -e ".[dev]"
+```
+
+## Documentation
+
+For further "getting started" instructions, a tutorial, examples, and an API reference,
+please check out the online documentation here: [COMPAS DR docs](https://blockresearchgroup.github.io/compas_dr)
+
+## Issue Tracker
+
+If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/BlockResearchGroup/compas_dr/issues).