diff --git a/README.md b/README.md index 8d7210e..e43a61a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# choreo-cli -CLI tool for WSO2 Choreo +# Choreo CLI + +Boost Developer Efficiency: A CLI for WSO2 Choreo + +## Installation +Download the choreo cli distribution and install. + +### Install via script + +#### MacOS, Linux, WSL +```bash +curl -o- https://cli.choreo.dev/install.sh | bash +``` + +#### Windows +```bash +iwr https://cli.choreo.dev/install.ps1 -useb | iex +``` + +### Download from GitHub +Download the appropriate version from the [releases](https://github.com/wso2/choreo-cli/releases) choreo cli github repository + +## Getting started + +1. Sign into your choreo account +```bash +choreo login +``` +2. List your projects +```bash +choreo list projects +``` +3. Describe your projects/components +```bash +choreo describe +```