From 3fb81c9c8110c989477a9be5d0f2cbb3be0e31f2 Mon Sep 17 00:00:00 2001
From: Myocardinal <97197770+Myocardinal@users.noreply.github.com>
Date: Fri, 30 Aug 2024 12:20:01 -0400
Subject: [PATCH] Updated readme.md with links to relevant resources and
 installation instructions

---
 readme.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index f7d842b..3d6cfb3 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,30 @@
-# eggwrap
\ No newline at end of file
+# eggwrap
+eggwrap is a wrapper for the Rust equality saturation framework [egg](https://dl.acm.org/doi/10.1145/3434304).
+eggwrap is a heavily-modified fork of [TENSAT](https://github.com/uwplse/tensat), with equality saturation rules tailored to the needs of the [CoolerSpace library](https://github.com/horizon-research/CoolerSpace).
+eggwrap is _not_ meant to be used as a standalone program!
+Please refer to the GitHub page for [onneggs](https://github.com/horizon-research/onneggs) for more details.
+
+## Installation
+
+### Dependencies
+eggwrap depends on [CBC](https://github.com/coin-or/Cbc).
+Please install CBC prior to installing eggwrap!
+
+### PyPI
+eggwrap is available on PyPI!
+
+```
+pip install eggwrap
+```
+
+### Building from source
+In order to build eggwrap from source, follow these commands:
+
+```
+git clone https://github.com/horizon-research/eggwrap.git
+cd eggwrap
+python3 -m venv venv
+pip install -r requirements.txt
+python3 -m maturin develop
+```
+