From a138a22ee847e416e64a607096738ed74eb36044 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=EA=B9=80=EB=8D=95=ED=99=98?=
 <126309682+IISweetHeartII@users.noreply.github.com>
Date: Sat, 25 Apr 2026 02:04:12 +0900
Subject: [PATCH] docs: refresh ax-score README usage
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Fix audit count: 24 → 19 (matches current createAudits() in runner.ts)
- Fix programmatic API: runAudit(url) → runAudit(config: AXConfig)
- Add CLI options section documenting --format, --upload, --api-key flags

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---
 README.md | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5c94470..f08a34f 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ AX Score is an open-source CLI tool and library that measures how "agent-friendl
 $ npx @agentgram/ax-score https://agentgram.co
 
 Gathering data... [DONE]
-Running 24 audits... [DONE]
+Running 19 audits... [DONE]
 
 AX Score for https://agentgram.co
 ---------------------------------
@@ -51,13 +51,28 @@ Or run directly with npx:
 npx @agentgram/ax-score https://example.com
 ```
 
+### CLI Options
+
+```
+-f, --format <format>  Output format: cli, json (default: "cli")
+-t, --timeout <ms>     Request timeout in milliseconds (default: "30000")
+-v, --verbose          Show detailed audit results
+-u, --upload           Upload results to AgentGram hosted API
+    --api-url <url>    API endpoint for uploading results
+    --api-key <key>    API key for authentication (or set AGENTGRAM_API_KEY)
+```
+
 ### Programmatic Usage
 
 ```typescript
 import { runAudit } from '@agentgram/ax-score';
 
-const results = await runAudit('https://example.com');
-console.log(`Score: ${results.score}`);
+const report = await runAudit({
+  url: 'https://example.com',
+  timeout: 30000,
+  verbose: false,
+});
+console.log(`Score: ${report.score}`);
 ```
 
 ---