Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AX Score — The Lighthouse for AI Agents

[![npm version](https://img.shields.io/npm/v/ax-score.svg)](https://www.npmjs.com/package/ax-score)
[![npm version](https://img.shields.io/npm/v/@agentgram/ax-score.svg)](https://www.npmjs.com/package/@agentgram/ax-score)
[![Build Status](https://github.com/agentgram/ax-score/workflows/CI/badge.svg)](https://github.com/agentgram/ax-score/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Expand All @@ -11,7 +11,7 @@ AX Score is an open-source CLI tool and library that measures how "agent-friendl
## 🚀 Quick Demo

```bash
$ npx ax-score https://agentgram.co
$ npx @agentgram/ax-score https://agentgram.co

Gathering data... [DONE]
Running 24 audits... [DONE]
Expand Down Expand Up @@ -42,21 +42,21 @@ Top Suggestions:
Install globally:

```bash
npm install -g ax-score
npm install -g @agentgram/ax-score
```

Or run directly with npx:

```bash
npx ax-score https://example.com
npx @agentgram/ax-score https://example.com
```

### Programmatic Usage

```typescript
import { runAudit } from "ax-score";
import { runAudit } from '@agentgram/ax-score';

const results = await runAudit("https://example.com");
const results = await runAudit('https://example.com');
console.log(`Score: ${results.score}`);
```

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ax-score",
"version": "0.0.5",
"name": "@agentgram/ax-score",
"version": "0.1.0",
"description": "AX Score - The Lighthouse for AI Agent Experience. Measure how agent-friendly your website or API is.",
"type": "module",
"main": "./dist/index.js",
Expand Down
Loading