From 4fd27ae45306fb2c413e5362d1c52c639ca8a96a Mon Sep 17 00:00:00 2001
From: Piotr Goszczynski <goszczynskip@gmail.com>
Date: Wed, 20 Nov 2024 18:12:40 +0100
Subject: [PATCH] docs: improve readme file

---
 README.md | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 3db1aa3..4c61014 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,23 @@
-# Arch gen
+# Arch Gen
 
-Tool to generate ARCHITECTURE file with mono repo diagrams with single command
+Arch Gen is a tool designed to generate an ARCHITECTURE file with monorepo diagrams using a single command. It leverages `mermaid` for diagram generation and can optionally use the `OpenAI API` for descriptions.
 
 ## Requirements
 
-- pnpm
-- monorepo
+- **pnpm**: A fast, disk space-efficient package manager
+- **Monorepo**: A repository that contains multiple projects
 
-## Usage
+## Basic Usage
+
+To use Arch Gen, run the following command:
 
 ```bash
-npx @tonik/arch-gen
+npx @tonik/arch-gen [options]
 ```
+
+### Options
+
+- `--ai [openai-api-key]`: Use this option to generate descriptions and tech stack information with the OpenAI API. If not provided, it will read from the `OPENAI_API_KEY` environment variable.
+- `-r, --root <path>`: Specify the root path of the monorepo.
+- `-y, --yes`: Skip prompts and generate diagrams with default options.
+- `-h, --help`: Display help information.