From ccc11e106df27c851295aa009ed3a95e41c76de7 Mon Sep 17 00:00:00 2001
From: ytimocin <ytimocin@microsoft.com>
Date: Mon, 20 Jan 2025 20:34:34 -0800
Subject: [PATCH] Updating README and CONTRIBUTING mds

Signed-off-by: ytimocin <ytimocin@microsoft.com>
---
 README.md                         | 78 +++++++++++++++++++++++--------
 docs/contributing/CONTRIBUTING.md |  7 +++
 2 files changed, 65 insertions(+), 20 deletions(-)
 create mode 100644 docs/contributing/CONTRIBUTING.md

diff --git a/README.md b/README.md
index e309a26..be78e70 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,28 @@
 
 With features like interactive flows, intelligent suggestions, and broad connection support, Prompt-Ops streamlines operations, saves time, and makes managing complex systems more approachable.
 
+## Table of Contents
+
+- [🤖 Prompt-Ops](#-prompt-ops)
+  - [Table of Contents](#table-of-contents)
+  - [🚀 Key Features](#-key-features)
+  - [🛠️ Installation](#️-installation)
+    - [Using Curl](#using-curl)
+    - [Using Homebrew (WIP)](#using-homebrew-wip)
+    - [Using Make](#using-make)
+  - [🎮 Usage](#-usage)
+  - [📜 Available Commands](#-available-commands)
+    - [🌍 General](#-general)
+    - [🌥️ Cloud](#️-cloud)
+    - [🚆 Kubernetes](#-kubernetes)
+    - [💿 Database](#-database)
+  - [〄 Supported Connection Types](#-supported-connection-types)
+    - [Available Now](#available-now)
+    - [Coming Soon](#coming-soon)
+  - [🎯 Planned Features](#-planned-features)
+  - [🤝 Contributing](#-contributing)
+  - [🪪 License](#-license)
+
 ## 🚀 Key Features
 
 - 🔍 **Natural Language Commands**: Interact with your services using plain English.
@@ -23,7 +45,7 @@ Run the installation script using **curl**:
 curl -fsSL https://raw.githubusercontent.com/prompt-ops/pops/main/scripts/install.sh | bash
 ```
 
-### Using Homebrew
+### Using Homebrew (WIP)
 
 You can also install Prompt-Ops via Homebrew:
 
@@ -40,38 +62,46 @@ To install locally using `make`:
 make install
 ```
 
+## 🎮 Usage
+
+You need to have `OPENAI_API_KEY` in the environment variables to be able to run certain features of Prompt-Ops. You can set it as follows:
+
+```bash
+export OPENAI_API_KEY=your_api_key_here
+```
+
 ## 📜 Available Commands
 
 ### 🌍 General
 
-- `pops connection create`: Create a new connection interactively.
-- `pops connection list`: List all connections.
-- `pops connection open [conn-name]`: Open a specific connection.
-- `pops connection delete [conn-name]`: Delete a specific connection.
-- `pops connection types`: Show available connection types.
+- `pops conn create`: Create a new connection interactively.
+- `pops conn list`: List all connections.
+- `pops conn open [conn-name]`: Open a specific connection.
+- `pops conn delete [conn-name]`: Delete a specific connection.
+- `pops conn types`: Show available connection types.
 
 ### 🌥️ Cloud
 
-- `pops connection cloud create`: Create a cloud connection interactively.
-- `pops connection cloud list`: List all cloud connections.
-- `pops connection cloud open [conn-name]`: Open a specific cloud connection.
-- `pops connection cloud delete [conn-name]`: Delete a specific cloud connection.
-- `pops connection cloud types`: Show supported cloud providers.
+- `pops conn cloud create`: Create a cloud connection interactively.
+- `pops conn cloud list`: List all cloud connections.
+- `pops conn cloud open [conn-name]`: Open a specific cloud connection.
+- `pops conn cloud delete [conn-name]`: Delete a specific cloud connection.
+- `pops conn cloud types`: Show supported cloud providers.
 
 ### 🚆 Kubernetes
 
-- `pops connection kubernetes create`: Create a Kubernetes connection.
-- `pops connection kubernetes list`: List Kubernetes connections.
-- `pops connection kubernetes open [conn-name]`: Open a specific Kubernetes connection.
-- `pops connection kubernetes delete [conn-name]`: Delete a Kubernetes connection.
+- `pops conn kubernetes create`: Create a Kubernetes connection.
+- `pops conn kubernetes list`: List Kubernetes connections.
+- `pops conn kubernetes open [conn-name]`: Open a specific Kubernetes connection.
+- `pops conn kubernetes delete [conn-name]`: Delete a Kubernetes connection.
 
 ### 💿 Database
 
-- `pops connection db create`: Create a database connection.
-- `pops connection db list`: List database connections.
-- `pops connection db open [conn-name]`: Open a specific database connection.
-- `pops connection db delete [conn-name]`: Delete a database connection.
-- `pops connection db types`: Show supported database types.
+- `pops conn db create`: Create a database connection.
+- `pops conn db list`: List database connections.
+- `pops conn db open [conn-name]`: Open a specific database connection.
+- `pops conn db delete [conn-name]`: Delete a database connection.
+- `pops conn db types`: Show supported database types.
 
 ## 〄 Supported Connection Types
 
@@ -101,3 +131,11 @@ make install
 - **Monitoring**: pops connection monitoring for logging and metrics (e.g., Prometheus).
 - **Sessions**: Keep track of prompts, commands, and history.
 - **CI/CD Pipelines**: Integrations with popular tools like Jenkins and GitHub Actions.
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [CONTRIBUTING.md](docs/contributing/CONTRIBUTING.md) for guidelines on how to get started.
+
+## 🪪 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
diff --git a/docs/contributing/CONTRIBUTING.md b/docs/contributing/CONTRIBUTING.md
new file mode 100644
index 0000000..c2ccc6a
--- /dev/null
+++ b/docs/contributing/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+# Contributing to Prompt-Ops
+
+## Table of Contents
+
+- [Adding a new connection type](connection/ADD_TYPE.md).
+- [Adding a subtype to a connection](connection/ADD_SUBTYPE.md).
+- [Adding a new AI model](ai/ADD_AI_MODEL.md).