From 936d97d4defe197a96fdfd21387bda099e73cd25 Mon Sep 17 00:00:00 2001
From: Piotr Goszczynski <goszczynskip@gmail.com>
Date: Wed, 20 Nov 2024 19:24:51 +0100
Subject: [PATCH] docs: improve readme

---
 README.md    | 7 +++++++
 package.json | 1 +
 2 files changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 4c61014..ec60416 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,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.
+
+**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.
 - `-h, --help`: Display help information.
diff --git a/package.json b/package.json
index 484fae2..f9446d3 100644
--- a/package.json
+++ b/package.json
@@ -4,6 +4,7 @@
   "description": "Architecture generator CLI tool",
   "main": "dist/index.js",
   "type": "module",
+  "git": "https://github.com/tonik/arch-gen",
   "bin": {
     "arch-gen": "./dist/index.js"
   },