Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
goszczynskip authored Nov 20, 2024
1 parent 936d97d commit d1106cc
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Arch Gen

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.
This is a small tool that generates an ARCHITECTURE file with mono repo diagrams using a single command. It produces `mermaid` diagrams and can optionally enhance descriptions using the `OpenAI API`.

## Requirements

Expand All @@ -17,13 +17,13 @@ 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.
- `--ai [openai-api-key]`: This option generates descriptions and tech stack information with the OpenAI API. If not provided, it will read from the `OPENAI_API_KEY` environment variable.

**Disclaimer**: When using the AI option, certain data is sent to the OpenAI API for processing. No code files are transmitted. The data includes:
- Directory names
- Monorepo file layout with external and internal package names
- Contents of `package.json`
- Contents of README files
> **Disclaimer**: When using the AI option, certain data is sent to the OpenAI API for processing. No code files are transmitted. The data includes:
> - Directory names
> - Monorepo file layout with external and internal package names
> - Contents of `package.json`
> - Contents of README files
- `-r, --root <path>`: Specify the root path of the monorepo.
- `-y, --yes`: Skip prompts and generate diagrams with default options.
Expand Down

0 comments on commit d1106cc

Please sign in to comment.