Skip to content

Commit ae730ed

Browse files
Updated documentation
1 parent 496653d commit ae730ed

File tree

3 files changed

+35
-13
lines changed

3 files changed

+35
-13
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,6 @@ const client = new OpenAI({
113113
```
114114

115115
### Notes
116-
- All 15+ providers are now fully supported with multiple integration options
116+
- All 17+ providers are now fully supported with multiple integration options
117117
- Zero breaking changes - existing code continues to work
118118
- Backward compatible with v1.0.0

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
**All-in-One AI Security for LLM Applications**
1212

13-
*Keep control of your AI. Detect prompt injection, jailbreaks, and adversarial attacks in real-time across 15+ providers with zero code changes.*
13+
*Keep control of your AI. Detect prompt injection, jailbreaks, and adversarial attacks in real-time across 17+ providers with zero code changes.*
1414

1515
[Quick Start](#quick-start) · [Documentation](https://www.lockllm.com/docs) · [Examples](#examples) · [Benchmarks](https://www.lockllm.com) · [API Reference](#api-reference)
1616

@@ -26,7 +26,7 @@ LockLLM is a state-of-the-art AI security ecosystem that detects prompt injectio
2626

2727
- **Real-Time Security Scanning** - Analyze every LLM request before execution with minimal latency (<250ms)
2828
- **Advanced ML Detection** - Models trained on real-world attack patterns for prompt injection and jailbreaks
29-
- **15+ Provider Support** - Universal coverage across OpenAI, Anthropic, Azure, Bedrock, Gemini, and more
29+
- **17+ Provider Support** - Universal coverage across OpenAI, Anthropic, Azure, Bedrock, Gemini, and more
3030
- **Drop-in Integration** - Replace existing SDKs with zero code changes - just change one line
3131
- **Completely Free** - BYOK (Bring Your Own Key) model with unlimited usage and no rate limits
3232
- **Privacy by Default** - Your data is never stored, only scanned in-memory and discarded
@@ -73,7 +73,7 @@ LockLLM provides production-ready AI security that integrates seamlessly into yo
7373
| **Evasion & Obfuscation Detection** | Catch sophisticated obfuscation including Unicode abuse, zero-width characters, and encoding-based attacks |
7474
| **Multi-Layer Context Analysis** | Analyze prompts across multiple context windows to detect attacks spanning conversation turns |
7575
| **Token-Level Threat Scoring** | Granular threat assessment identifying which specific parts of input contain malicious patterns |
76-
| **15+ Provider Support** | OpenAI, Anthropic, Gemini, Azure, Bedrock, Groq, DeepSeek, and more |
76+
| **17+ Provider Support** | OpenAI, Anthropic, Gemini, Azure, Bedrock, Groq, DeepSeek, and more |
7777
| **Drop-in Integration** | Replace `new OpenAI()` with `createOpenAI()` - no other changes needed |
7878
| **TypeScript Native** | Full type safety with comprehensive type definitions and IDE support |
7979
| **Streaming Compatible** | Works seamlessly with streaming responses from any provider |
@@ -84,16 +84,38 @@ LockLLM provides production-ready AI security that integrates seamlessly into yo
8484

8585
## Installation
8686

87+
Choose your preferred package manager:
8788
```bash
88-
# Install the SDK
89+
# npm
8990
npm install @lockllm/sdk
9091

91-
# For wrapper functions, install relevant peer dependencies
92-
npm install openai # For OpenAI, Groq, DeepSeek, Mistral, etc.
93-
npm install @anthropic-ai/sdk # For Anthropic Claude
94-
npm install cohere-ai # For Cohere (optional)
92+
# pnpm (faster, saves disk space)
93+
pnpm add @lockllm/sdk
94+
95+
# yarn
96+
yarn add @lockllm/sdk
9597
```
9698

99+
### Peer Dependencies
100+
101+
For wrapper functions, install the relevant provider SDKs:
102+
103+
```bash
104+
# npm
105+
npm install openai @anthropic-ai/sdk cohere-ai
106+
107+
# pnpm
108+
pnpm add openai @anthropic-ai/sdk cohere-ai
109+
110+
# yarn
111+
yarn add openai @anthropic-ai/sdk cohere-ai
112+
```
113+
114+
**Provider breakdown:**
115+
- `openai` - For OpenAI, Groq, DeepSeek, Mistral, etc.
116+
- `@anthropic-ai/sdk` - For Anthropic Claude
117+
- `cohere-ai` - For Cohere (optional)
118+
97119
**Note:** Peer dependencies are optional and only required if you use the wrapper functions for those providers.
98120

99121
## Quick Start
@@ -222,7 +244,7 @@ Compare detection accuracy and performance metrics at [lockllm.com/benchmarks](h
222244
| **Real-Time Protection** | ✅ <250ms latency | ✅ Built-in | ✅ Yes | ❌ Too slow |
223245
| **Setup Time** | 5 minutes | Included | Days to weeks | N/A |
224246
| **Maintenance** | None | None | Constant updates | Constant |
225-
| **Multi-Provider Support** |15+ providers | Single provider | Custom per provider | N/A |
247+
| **Multi-Provider Support** |17+ providers | Single provider | Custom per provider | N/A |
226248
| **False Positives** | Low (~2-5%) | N/A | High (15-30%) | N/A |
227249
| **Cost** | Free (BYOK) | Free | Dev time + infrastructure | $$$ |
228250
| **Attack Coverage** | Comprehensive | Content policy only | Pattern-based only | Manual |
@@ -422,7 +444,7 @@ try {
422444

423445
## Supported Providers
424446

425-
LockLLM supports 17 AI providers with three flexible integration methods:
447+
LockLLM supports 17+ AI providers with three flexible integration methods:
426448

427449
### Provider List
428450

@@ -476,7 +498,7 @@ LockLLM uses a secure BYOK (Bring Your Own Key) model - you maintain control of
476498

477499
- Use this single key in your SDK configuration
478500
- Authenticates requests to the LockLLM security gateway
479-
- Works across all 15+ providers with one key
501+
- Works across all 17+ providers with one key
480502
- **This is the only key that goes in your code**
481503

482504
### Request Flow

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@lockllm/sdk",
33
"version": "1.0.1",
4-
"description": "Enterprise-grade AI security SDK providing real-time protection against prompt injection, jailbreaks, and adversarial attacks. Drop-in replacement for OpenAI, Anthropic, and 15+ providers with zero code changes. Includes REST API, proxy mode, browser extension, and webhook support. Free BYOK model with unlimited scanning.",
4+
"description": "Enterprise-grade AI security SDK providing real-time protection against prompt injection, jailbreaks, and adversarial attacks. Drop-in replacement for OpenAI, Anthropic, and 17+ providers with zero code changes. Includes REST API, proxy mode, browser extension, and webhook support. Free BYOK model with unlimited scanning.",
55
"main": "./dist/index.js",
66
"module": "./dist/index.mjs",
77
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)