From f59535c4ce5d6208fe523820af8db620cabd937b Mon Sep 17 00:00:00 2001
From: Dmitrii Gridnev <dgridnev@qase.io>
Date: Thu, 12 Dec 2024 15:26:20 +0100
Subject: [PATCH] docs: Improve installation instructions and usage details

- Added instructions for installing Qase CLI via `go install`
- Updated Docker installation steps for clarity
- Enhanced documentation with clearer usage guidelines and command details

#57
---
 README.md | 66 ++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 43 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index b7ec9ae..c8989a5 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,64 @@
 # Qase CLI
 
-`qli` is Qase on the command line. It allows you to work with test runs and import test results.
+`qli` is the command-line interface (CLI) for Qase, enabling users to interact with test runs and import test results
+directly from the terminal.
 
-Qase CLI is available for Qase and Qase Enterprise users.
+Qase CLI is available for both **Qase** and **Qase Enterprise** users.
 
-# Installation
+## Installation
 
-## Build from source
+### Install via `go install`
 
-1. Clone the repository
+The easiest way to install Qase CLI is using `go install`:
 
 ```bash
-git clone https://github.com/qase-tms/qasectl.git && cd qasectl
+go install github.com/qase-tms/qasectl@latest
 ```
 
-2. Build the binary
+Make sure to add `$GOPATH/bin` to your `$PATH` environment variable to be able to run the `qasectl` command.
 
-```bash
-make build
-```
+### Build from Source
 
-You will find the binary in the `build` directory.
+If you'd like to build the CLI from source, follow these steps:
 
-## Docker image
+1. Clone the repository:
 
-1. Pull the Docker image
+    ```bash
+    git clone https://github.com/qase-tms/qasectl.git && cd qasectl
+    ```
 
-```bash
-docker pull ghcr.io/qase-tms/qase-cli:latest
-```
+2. Build the binary using `make`:
+
+    ```bash
+    make build
+    ```
+
+   The compiled binary will be located in the `build` directory.
+
+### Docker Image
 
-2. Run the Docker container
+You can also use Qase CLI via Docker. Follow these steps:
+
+1. Pull the latest Docker image:
+
+    ```bash
+    docker pull ghcr.io/qase-tms/qase-cli:latest
+    ```
+
+2. Run the Docker container:
+
+    ```bash
+    docker run --rm ghcr.io/qase-tms/qase-cli:latest version
+    ```
+
+## Usage
+
+`qli` is designed to be used directly in your terminal. You can run the following command to view available options:
 
 ```bash
-docker run --rm ghcr.io/qase-tms/qase-cli:latest version 
+qli --help
 ```
 
-# Usage
-
-The tool is designed to be used in a terminal.
-You can run `qli` with the `--help` flag to see the available commands and options.
+This will show all available commands and their descriptions.
 
-You can find more information about the commands and options in the [documentation](docs/command.md).
+For more detailed information about each command and option, refer to the [full documentation](docs/command.md).