Skip to content

Commit 2ef776f

Browse files
committed
Update READMEs: honest, clear, aesthetic
- Removed pretentious language and marketing speak - Added real developer experience based on actual testing - Clear, direct explanations of what it actually does - Aesthetic improvements with better formatting - Accurate feature descriptions based on verified functionality - Honest about capabilities without overselling - Reflects the 30-second integration we tested The README now matches what developers actually experience: two lines of code, automatic tracking, no code changes needed.
1 parent 9e23e48 commit 2ef776f

1 file changed

Lines changed: 40 additions & 42 deletions

File tree

README.md

Lines changed: 40 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,54 @@
22

33
# 🛡️ AgentGuard
44

5-
**Stop AI agents from burning your money**
5+
**Real-time cost monitoring for AI agents**
66

77
[![npm version](https://img.shields.io/npm/v/agent-guard.svg)](https://npmjs.com/package/agent-guard)
88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
99
[![Node.js](https://img.shields.io/badge/node-%3E%3D12.0.0-brightgreen)](https://nodejs.org/)
10-
[![GitHub stars](https://img.shields.io/github/stars/dipampaul17/AgentGuard?style=social)](https://github.com/dipampaul17/AgentGuard)
1110

12-
*The emergency brake for runaway AI costs*
11+
*Two lines of code. Automatic cost tracking. No surprises.*
1312

1413
</div>
1514

1615
---
1716

18-
## 🚨 The Problem
17+
## The Problem
1918

20-
Every AI developer has been there:
21-
- 🔥 **Infinite loop** burns through $500 overnight
22-
- 📈 **Development costs** exceed the solution
23-
- 💳 **OpenAI bills** that make you cry
24-
- 😰 **Deploy anxiety** because agents can go rogue
19+
Building AI agents? Your biggest fear is probably this:
20+
- **Runaway costs** from infinite loops or bugs
21+
- **Development bills** that spiral out of control
22+
- **No visibility** into what your agent is actually spending
23+
- **Production anxiety** about deploying autonomous systems
2524

26-
## The Solution
25+
## The Solution
2726

28-
AgentGuard is a **production-ready kill switch** that monitors your AI agent costs in real-time and automatically terminates processes when they exceed your budget. **Battle-tested** with comprehensive test coverage and CI/CD pipelines.
27+
AgentGuard automatically tracks your AI API costs in real-time and stops execution when you hit your budget. No code changes needed - just add two lines and keep building.
2928

3029
```javascript
31-
// Before: Vulnerable to runaway costs
32-
const response = await openai.chat.completions.create({...});
33-
34-
// After: Protected by AgentGuard
30+
// Add these two lines to any AI agent:
3531
const agentGuard = require('agent-guard');
3632
await agentGuard.init({ limit: 50 });
33+
34+
// Your existing code works unchanged:
3735
const response = await openai.chat.completions.create({...});
38-
// 🛡️ AgentGuard now monitors every API call automatically
39-
```
36+
console.log(response); // ← AgentGuard automatically tracks this
4037

41-
## 🎯 Key Features
38+
// Real-time cost display:
39+
// 💸 $12.34 / $50 24.7%
40+
```
4241

43-
- **🔥 Minimal Dependencies** - Lightweight ~18KB core file with optional tokenizers
44-
- **⚡ Zero Configuration** - Works out of the box
45-
- **🎨 Beautiful Terminal UI** - Real-time cost display with warnings
46-
- **🤖 Multi-Model Support** - OpenAI, Anthropic, Claude, GPT-4o
47-
- **🌐 Multi-Platform** - Node.js and Browser with TypeScript support
48-
- **🚨 Instant Kill Switch** - Terminates at your cost limit
49-
- **📊 Accurate Tracking** - Real token counting and pricing
50-
- **✅ Production Ready** - Comprehensive test suite, CI/CD, stable release
42+
## What It Does
5143

52-
## 🚀 Quick Start
44+
- **Automatic tracking** - Watches console.log, fetch, and axios automatically
45+
- **Real-time display** - Shows current costs as your agent runs
46+
- **Multi-model support** - OpenAI (GPT-4, GPT-3.5), Anthropic (Claude), embeddings
47+
- **Flexible limits** - Set budget in dollars, auto-kill or just warn
48+
- **Zero code changes** - Works with your existing OpenAI/Anthropic code
49+
- **TypeScript support** - Full type definitions included
50+
- **18KB lightweight** - No bloat, minimal dependencies
5351

54-
Ready to protect your AI budget in 30 seconds?
52+
## Quick Start
5553

5654
### Installation
5755

@@ -207,31 +205,31 @@ node verify-installation.js
207205

208206
MIT - Use anywhere, even commercial projects.
209207

210-
## 🆘 Support
208+
## Support
209+
210+
Having issues? Found a bug?
211211

212-
- 📧 **Issues**: [GitHub Issues](https://github.com/dipampaul17/AgentGuard/issues)
213-
- 💬 **Questions**: [GitHub Discussions](https://github.com/dipampaul17/AgentGuard/discussions)
214-
- 🐛 **Bug Reports**: [Bug Report Template](https://github.com/dipampaul17/AgentGuard/issues/new)
212+
- [GitHub Issues](https://github.com/dipampaul17/AgentGuard/issues) for bugs
213+
- [GitHub Discussions](https://github.com/dipampaul17/AgentGuard/discussions) for questions
215214

216-
## 📋 What's New in v1.1.0
215+
## What's Included
217216

218-
- **Fixed CI/CD Issues** - Resolved all test timing issues for reliable deployments
219-
- 🔧 **Enhanced Test Suite** - Comprehensive testing with 200ms wait times for CI environments
220-
- 🚀 **Production Stability** - Battle-tested codebase ready for enterprise use
221-
- 📦 **NPM Ready** - Clean package with only essential files (31.8kB total)
222-
- 🛡️ **Zero Gaps** - Every claimed feature is fully implemented and tested
217+
- **Core monitoring** - Tracks OpenAI, Anthropic, and embedding costs
218+
- **Working examples** - Real LangChain integration, runaway loop demo
219+
- **TypeScript support** - Full type definitions
220+
- **Browser build** - Use in web applications
221+
- **Verification script** - Test installation instantly
223222

224223
---
225224

226225
<div align="center">
227226

228-
**🛡️ AgentGuard v1.1.0 - Stop losing money. Start shipping safely.**
227+
**AgentGuard - Real-time cost monitoring for AI agents**
229228

230-
**Production-ready | CI/CD tested | Zero gaps**
229+
*Two lines of code. Automatic tracking. No surprises.*
231230

232231
[⭐ Star on GitHub](https://github.com/dipampaul17/AgentGuard)
233-
[📦 NPM Package](https://npmjs.com/package/agent-guard)
234-
[📖 Quick Start](QUICKSTART.md)
232+
[📦 NPM Package](https://npmjs.com/package/agent-guard)
235233

236234
*Trusted by developers building the future of AI*
237235

0 commit comments

Comments
 (0)