From 91b2291784cd3751ddecc31859f2fba289d04a85 Mon Sep 17 00:00:00 2001
From: Kye <kye@apacmediasolutions.com>
Date: Thu, 18 Apr 2024 08:30:44 -0400
Subject: [PATCH] [DOCS][CLEANUP]

---
 docs/install.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++
 docs/mkdocs.yml | 13 ++++++-
 2 files changed, 105 insertions(+), 1 deletion(-)
 create mode 100644 docs/install.md

diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 00000000..7adbe441
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,93 @@
+<div align="center">
+  <p>
+    <a align="center" href="" target="_blank">
+      <img
+        width="850"
+        src="https://github.com/kyegomez/swarms/raw/master/images/swarmslogobanner.png"
+      >
+    </a>
+  </p>
+</div>
+
+# Installation Guide
+
+You can install `swarms` with pip in a
+[**Python>=3.8**](https://www.python.org/) environment.
+
+!!! example "pip install (recommended)"
+
+    === "headless"
+        The headless installation of `swarms` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
+
+        ```bash
+        pip install swarms
+        ```
+
+!!! example "pip install (recommended)"
+        If the installation above doesn't work try the following with PIP3
+
+        ```bash
+        pip3 install -U swarms
+        ```
+
+
+
+!!! example "git clone (for development)"
+
+    === "virtualenv"
+
+        ```bash
+        # clone repository and navigate to root directory
+        git clone https://github.com/kyegomez/swarms.git
+        cd swarms
+
+        # setup python environment and activate it
+        python3 -m venv venv
+        source venv/bin/activate
+        pip install --upgrade pip
+
+        # headless install
+        pip install -e "."
+
+        # desktop install
+        pip install -e ".[desktop]"
+        ```
+
+    === "poetry"
+
+        ```bash
+        # clone repository and navigate to root directory
+        git clone https://github.com/kyegomez/swarms.git
+        cd swarms
+
+        # setup python environment and activate it
+        poetry env use python3.10
+        poetry shell
+
+        # headless install
+        poetry install
+
+        # desktop install
+        poetry install --extras "desktop"
+        ```
+
+!!! example "NPM install |WIP|"
+
+    === "headless"
+        Get started with the NPM implementation of Swarms with this command:
+
+        ```bash
+        npm install swarms-js
+        ```
+
+
+## Documentation
+
+[Learn more about swarms →](swarms/)
+
+
+## Examples
+
+Check out Swarms examples for building agents, data retrieval, and more.
+
+[Checkout Swarms examples →](examples/)
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index dd48090f..5c172288 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,5 +1,15 @@
+
 docs_dir: '.'  # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml
 site_name: Swarms Documentation
+site_url: https://swarms.apac.ai
+site_author: Swarms
+site_description: Orchestrate Swarms of Agents From Any Framework Like OpenAI, Langchain, and Etc for Real World Workflow Automation.
+repo_name: kyegomez/swarms
+repo_url: https://github.com/kyegomez/swarms
+edit_uri: https://github.com/kyegomez/swarms/tree/main/docs
+copyright: TGSC Corp 2024. All rights reserved.
+
+
 plugins:
   # - glightbox
   - search
@@ -95,9 +105,10 @@ markdown_extensions:
 nav:
 - Home:
     - Overview: "index.md"
+    - Install: "install.md"
     - Limitations of Individual Agents: "limits_of_individual_agents.md"
     - Build an Agent: "diy_your_own_agent.md"
-    - Agent with tools: "examples/tools_agent.md"
+    - Build an Agent with tools: "examples/tools_agents.md"
 - Swarms Cloud API:
   - Overview: "swarms_cloud/main.md"
   - Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.md"