From 5d172906bdbdbfbbfada4fedf197fe2e9820c156 Mon Sep 17 00:00:00 2001
From: Myocardinal <development@myocardinal.com>
Date: Fri, 30 Aug 2024 18:49:27 -0400
Subject: [PATCH] Updated readme file with installation steps and usage details

---
 pyproject.toml |  2 +-
 readme.md      | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 5dc93ac..b27221e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "onneggs"
-version = "0.0.4"
+version = "1.0.0"
 requires-python = ">=3.10"
 dependencies = ["onnx", "maturin", "numpy", "onnxruntime", "click", "eggwrap"]
 readme = "readme.md"
\ No newline at end of file
diff --git a/readme.md b/readme.md
index b08cff7..dbf7898 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,44 @@
-# onneggs
\ No newline at end of file
+# onneggs
+
+onneggs is an optimizer designed to optimize CoolerSpace ONNX files.
+The repository for CoolerSpace can be found [here](https://github.com/horizon-research/CoolerSpace).
+
+## Installation
+
+### Dependencies
+onneggs requires [eggwrap](https://github.com/horizon-research/eggwrap) to be installed.
+This dependency is handled automatically if using PyPI.
+Additionally [Cbc](https://github.com/coin-or/Cbc) is also required.
+
+### PyPI
+onneggs is on PyPI! 
+Install onneggs with the following command:
+
+```
+pip install onneggs
+```
+
+Please note that we only support Linux distributions for this package, and only for python versions 3.10+.
+
+### Building from source on Linux
+In order to build onneggs, [eggwrap](https://github.com/horizon-research/eggwrap) must first be built.
+Use the following commands to build onneggs from source:
+
+```
+git clone https://github.com/horizon-research/onneggs
+cd onneggs
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+pip install build
+python3 -m build
+```
+
+## Usage
+onneggs can be invoked as a Python module:
+
+```
+python3 -m onneggs [INPUT_FILE] [OUTPUT_FILE]
+```
+
+Where [INPUT_FILE] is the path to the input ONNX file, and [OUTPUT_FILE] is the desired output path.