From e6c6064d79bc703f89887dede49a4f5f8a9d08f7 Mon Sep 17 00:00:00 2001
From: vipul-rawat <vipul.rawat@gofr.dev>
Date: Wed, 18 Dec 2024 15:25:46 +0530
Subject: [PATCH] edit readme to have zopdev for docker images and add new
 command docs

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 44 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 982b1ed..99c482b 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ Zop is a comprehensive tool for managing cloud infrastructure. It consists of th
 
 ### Prerequisites
 
-- Docker installed on your system.
+- Docker installed on user system.
 
 ---
 
@@ -22,13 +22,13 @@ Zop is a comprehensive tool for managing cloud infrastructure. It consists of th
 Run the following command to pull and start the Docker image for the zop-api:
 
 ```bash
-    docker run -d -p 8000:8000 --name zop-api zop.dev/zop-api:v0.0.1
+    docker run -d -p 8000:8000 --name zop-api zopdev/zop-api:v0.0.2
 ```
 
 #### zop-ui
 Run the following command to pull and start the Docker image for the zop-ui:
 ```bash
-    docker run -d -p 3000:3000 -e NEXT_PUBLIC_API_BASE_URL='http://localhost:8000' --name zop-ui zop.dev/zop-ui:v0.0.1
+    docker run -d -p 3000:3000 -e NEXT_PUBLIC_API_BASE_URL='http://localhost:8000' --name zop-ui zopdev/zop-ui:v0.0.2
 ```
 
 > **Note:** The environment variable `NEXT_PUBLIC_API_BASE_URL` is used by zop-ui to connect to the zop-api. Ensure that the value matches the API's running base URL.
@@ -56,4 +56,44 @@ Run the following command install zop-cli:
 
    ```bash
     zop cloud list
-    ```
\ No newline at end of file
+    ```
+3. **application add -name=<app_name>**
+
+   Adds a new application to the zop-api. This lets users add environment is ascending order of
+   their continuous delivery sequence.
+    
+    ```bash
+     zop application add -name=<app_name>
+     ```
+4. **application list**
+   
+   Lists all the applications present in the zop-api for a selected application.
+
+    ```bash
+     zop application list
+     ```
+5. **environment add**
+
+   Adds a new environment to the zop-api. This lets user add deployment in ascending order of
+   their continuous delivery sequence. Users can add multiple environments to an application.
+
+    ```bash
+     zop environment add
+     ```
+6. **environment list**
+
+   Lists all the environments present in the zop-api for a selected application.
+
+    ```bash
+     zop environment list
+     ```
+   
+7. **deployment add**
+
+   Adds a new deployment to the zop-api. The users are needed to select cloud-account and the application
+   environment where the deployment space is needed to be configured. Then users can select from a list of
+   available options(ex, GKE cluster, AWS EC2 instance, etc.) to deploy their application.
+
+    ```bash
+     zop deployment add
+     ```
\ No newline at end of file