From f33d4c0a7eb0ee4393aaee3952d1c94c55afe33f Mon Sep 17 00:00:00 2001
From: Ikechukwu Uchendu <iuchendu@g.harvard.edu>
Date: Fri, 6 Sep 2024 13:58:28 -0400
Subject: [PATCH] Added instructions for PyPI installation

---
 README.md                   | 22 +++++++++++++++-------
 docs/content/basic_usage.md | 17 +++++++++++++++--
 2 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 49a650b..e39bbb2 100644
--- a/README.md
+++ b/README.md
@@ -51,13 +51,16 @@ A2Perf provides benchmark environments in the following domains:
 
 ## Installation
 
-A2Perf can be installed on your local machine:
+A2Perf can be installed directly from PyPI:
 
 ```bash
-git clone https://github.com/Farama-Foundation/A2Perf.git
-cd A2Perf
-git submodule sync --recursive
-git submodule update --init --recursive
+pip install a2perf[all]
+```
+
+A2Perf can also be installed from source for development purposes:
+
+```bash
+git clone https://github.com/Farama-Foundation/A2Perf.git --recursive
 pip install -e .[all]
 ```
 
@@ -66,6 +69,12 @@ pip install -e .[all]
 To install specific packages, you can use the following commands:
 
 ```bash
+# From PyPI
+pip install a2perf[web_navigation]
+pip install a2perf[circuit_training]  
+pip install a2perf[quadruped_locomotion]
+
+# From source
 pip install -e .[web_navigation]
 pip install -e .[quadruped_locomotion]
 pip install -e .[circuit_training]
@@ -79,8 +88,7 @@ It can be used for development and testing but if you want to conduct serious (
 time and resource-extensive) experiments on Windows,
 please consider
 using [Docker](https://docs.docker.com/docker-for-windows/install/)
-or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) with Linux
-version.
+or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 
 ## API
 
diff --git a/docs/content/basic_usage.md b/docs/content/basic_usage.md
index 6920c5b..b7c6c3c 100644
--- a/docs/content/basic_usage.md
+++ b/docs/content/basic_usage.md
@@ -40,8 +40,21 @@ env = gym.make('QuadrupedLocomotion-DogPace-v0')
 
 # Installation
 
-Note: The pip installation is not available yet. Users should install from
-source for now.
+## Installing from PyPI
+
+To install A2Perf from PyPI, run the following command:
+
+```bash
+pip install a2perf
+```
+
+You can also install specific domains by specifying the package name:
+
+```bash
+pip install a2perf[web-navigation]
+pip install a2perf[circuit-training]
+pip install a2perf[quadruped-locomotion]
+```
 
 ## Installing from source