Skip to content

Commit 1e1dee1

Browse files
Update README.md
1 parent 496653d commit 1e1dee1

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,39 @@ LockLLM provides production-ready AI security that integrates seamlessly into yo
8484

8585
## Installation
8686

87+
Choose your preferred package manager:
88+
8789
```bash
88-
# Install the SDK
90+
# npm
8991
npm install @lockllm/sdk
9092

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)
93+
# pnpm (faster, saves disk space)
94+
pnpm add @lockllm/sdk
95+
96+
# yarn
97+
yarn add @lockllm/sdk
98+
```
99+
100+
### Peer Dependencies
101+
102+
For wrapper functions, install the relevant provider SDKs:
103+
104+
```bash
105+
# npm
106+
npm install openai @anthropic-ai/sdk cohere-ai
107+
108+
# pnpm
109+
pnpm add openai @anthropic-ai/sdk cohere-ai
110+
111+
# yarn
112+
yarn add openai @anthropic-ai/sdk cohere-ai
95113
```
96114

115+
**Provider breakdown:**
116+
- `openai` - For OpenAI, Groq, DeepSeek, Mistral, etc.
117+
- `@anthropic-ai/sdk` - For Anthropic Claude
118+
- `cohere-ai` - For Cohere (optional)
119+
97120
**Note:** Peer dependencies are optional and only required if you use the wrapper functions for those providers.
98121

99122
## Quick Start

0 commit comments

Comments
 (0)