Merge pull request #16 from kaje94/update-to-choreo-v2

Update choreo extension readme to v2

README.md

@@ -1,3 +1,7 @@
+## ⚠️ Click [here](README_V2.md) for details on the upcoming version 2.0
+
+<br>
+
 # The Choreo extension for Visual Studio Code
 
 The Choreo VS Code extension enhances your local development experience with [Choreo projects](https://wso2.com/choreo/) by providing a wide range of project and component management capabilities. Learn more about [Choreo](https://wso2.com/choreo/docs/).
@@ -8,50 +12,50 @@ You need an active Choreo account to utilize the capabilities of the Choreo exte
 
 1. Install the [Choreo VS Code extension](https://marketplace.visualstudio.com/items?itemName=WSO2.choreo) and wait for the extension to be initialized.
 
-2.  Sign in to Choreo using one of the following methods.
-    - Via the `Sign In` prompt displayed upon successful initialization of the extension
-    - Via the `Sign In` options available by clicking the Choreo icon on the activity bar of your VS Code editor
+2. Sign in to Choreo using one of the following methods.
 
-    ![Sign In](docs/choreo-extension/images/signIn.gif)
+   - Via the `Sign In` prompt displayed upon successful initialization of the extension
+   - Via the `Sign In` options available by clicking the Choreo icon on the activity bar of your VS Code editor
 
->**Tip:** The above step redirects you to an external URI to complete the authentication process. If the sign-in is successful, the organization linked to your Choreo account will be visible in the Choreo activity panel.
+   ![Sign In](docs/choreo-extension/images/v1/signIn.gif)
 
+> **Tip:** The above step redirects you to an external URI to complete the authentication process. If the sign-in is successful, the organization linked to your Choreo account will be visible in the Choreo activity panel.
 
 ## Create a project
 
 Follow the steps below to create a new Choreo project directly from VS Code.
 
->**Tip:** If you already have a Choreo project, you can skip this section and move to the [Open Project](#open-project) section.
+> **Tip:** If you already have a Choreo project, you can skip this section and move to the [Open Project](#open-project) section.
 
 1. In the Choreo activity panel, click the **Create Project** button to create a new project.
 
-    >**Tip:** Alternatively, execute the **Create new project** command in the Command palette.
+   > **Tip:** Alternatively, execute the **Create new project** command in the Command palette.
 
 2. In the **New Choreo Project** pane, complete the new project wizard by specifying appropriate values for the required fields.
 
-    >**Tip:** If you want to use a single repo to store all the components of the project, select the **Mono repository** option, and provide a GitHub **Repository** and its **Organization**. This will redirect you to GitHub to authorize a repository to link it to the project.
+   > **Tip:** If you want to use a single repo to store all the components of the project, select the **Mono repository** option, and provide a GitHub **Repository** and its **Organization**. This will redirect you to GitHub to authorize a repository to link it to the project.
 
-![New Project Wizard](docs/choreo-extension/images/CreateProject.gif)
+![New Project Wizard](docs/choreo-extension/images/v1/CreateProject.gif)
 
 ## Open project
 
-Follow the step below to open an exisiting Choreo project and create a copy of it in the local environment. 
+Follow the step below to open an exisiting Choreo project and create a copy of it in the local environment.
 
 1. Click **Open Project** button to get the project list present in your organization.
 
-2. In the Command palette, select the project from the **PROJECTS** list. 
+2. In the Command palette, select the project from the **PROJECTS** list.
 
 3. Select a directory in your local machine to store the project.
 
-    >**Tip:** Once the project is cloned, it opens as a workspace in VS Code. Each component will be available as a workspace item. 
+   > **Tip:** Once the project is cloned, it opens as a workspace in VS Code. Each component will be available as a workspace item.
 
-![Open Project](docs/choreo-extension/images/openProject.gif)
+![Open Project](docs/choreo-extension/images/v1/openProject.gif)
 
 ## Design and develop your application
 
 Follow the steps below to design and develop your application by adding components to it.
 
->**Info:** This creates the sources for each component locally in the given repo, and each component will be added as a workspace item in VS Code. To sync your local changes with the Choreo console, you'll need to perform a [push your changes to Choreo](#push-your-changes-to-choreo) step. This will update the Choreo console with the latest version of your components.
+> **Info:** This creates the sources for each component locally in the given repo, and each component will be added as a workspace item in VS Code. To sync your local changes with the Choreo console, you'll need to perform a [push your changes to Choreo](#push-your-changes-to-choreo) step. This will update the Choreo console with the latest version of your components.
 
 1. In the Choreo activity panel, click **Add Component** button.
 
@@ -61,7 +65,7 @@ Follow the steps below to design and develop your application by adding componen
 
 4. Click **+** icon in components section to create components.
 
-![Architecture Diagram](docs/choreo-extension/images/CreateComponent.gif)
+![Architecture Diagram](docs/choreo-extension/images/v1/CreateComponent.gif)
 
 The above step will create sources for each component locally in the given repo, and each component will be added as a workspace item in VS Code.
 
@@ -79,9 +83,9 @@ Follow the steps below to push the changes to Choreo after creating the componen
 
 5. Click **Push to Choreo** to upload the components to the Choreo platform.
 
-    >**Info:** Once you push the components, they will be visible on the Choreo platform. 
+   > **Info:** Once you push the components, they will be visible on the Choreo platform.
 
-![Push Changes](docs/choreo-extension/images/PushToChoreo.gif)
+![Push Changes](docs/choreo-extension/images/v1/PushToChoreo.gif)
 
 ## Deploy your components
 

README_V2.md

@@ -0,0 +1,69 @@
+## ⚠️ Choreo Extension V2.0 is under development
+
+> You can test it out by switching to the pre-release version within the Choreo extension for VS Code.
+
+<br>
+
+# Choreo Extension for Visual Studio Code V2.0
+
+The Choreo VS Code extension enhances your local development experience with [Choreo components](https://wso2.com/choreo/) by providing comprehensive component management capabilities. Learn more about [Choreo](https://wso2.com/choreo/docs/).
+
+## Getting Started
+
+To utilize the Choreo extension in the VS Code editor, you need an active Choreo account. Follow these steps to set up the extension:
+
+1. Install the [Choreo VS Code extension](https://marketplace.visualstudio.com/items?itemName=WSO2.choreo) and wait for initialization.
+
+2. Sign in to Choreo using one of the following methods:
+
+   - Click the `Sign In` button within the Choreo activity panel.
+   - Use the `Sign In` command provided by the Choreo extension.
+
+   ![Sign In](docs/choreo-extension/images/v2/sign-in.png)
+
+> **Tip:** Upon successful sign-in, your account details will be visible in the user account view of the Choreo activity panel.
+
+## Create and Manage Components
+
+Follow these steps to create and manage Choreo components directly from VS Code:
+
+1. In the Choreo activity panel, click the **Create Component** button or execute the **Create new component** command from the Command palette.
+
+   ![Create component button](docs/choreo-extension/images/v2/create-component-btn.png)
+
+2. Select the organization and project for your component. You can also create a new project if needed.
+
+3. Provide component details in the **New Choreo Component** pane and click **Create**.
+
+   ![Component form](docs/choreo-extension/images/v2/component-form.png)
+
+> **Tip:** Ensure the selected directory is within a Git repository.
+
+4. Once created, the component details view will open, and the Choreo activity panel will update with the new component.
+
+   ![Component details](docs/choreo-extension/images/v2/component-details-view.png)
+
+> **Tip:** A `.choreo/link.yaml` file will be generated to associate the component with the directory. If not available, regenerate it using the `Link Directory` command.
+
+5. The component details view allows various actions such as:
+   - Trigger builds for selected commits
+   - View list of builds and statuses
+   - Diagnose build failures with build logs
+   - Deploy builds in available environments
+   - Access runtime logs and deployed component URLs
+
+## Discover Additional Features
+
+Access a range of functionalities provided by the Choreo extension by opening the VS Code command palette and typing `Choreo`.
+
+## Troubleshooting
+
+To troubleshoot Choreo extension issues:
+
+1. Open the **OUTPUT** pane by clicking **View** and then **OUTPUT** from the main menu.
+
+2. Select **Choreo** from the drop-down menu on the right-hand side to view Choreo output for troubleshooting.
+
+## Get Help
+
+Feel free to create [GitHub issues](https://github.com/wso2/choreo-vscode/issues) to reach out to us.