Skip to content

Commit

Permalink
docs: improve readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
goszczynskip committed Nov 20, 2024
1 parent 2d1a4ae commit 4fd27ae
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 4fd27ae

Please sign in to comment.