Skip to content

Commit

Permalink
Update readme callout (#95)
Browse files Browse the repository at this point in the history
* chore: Bump version

* chore: Update readme callout

* chore: Fix grammar

* Update README.md

Signed-off-by: Daniel Chalef <[email protected]>

---------

Signed-off-by: Daniel Chalef <[email protected]>
Co-authored-by: Daniel Chalef <[email protected]>
  • Loading branch information
paul-paliychuk and danielchalef authored Sep 30, 2024
1 parent 40bb8d6 commit ba73bb0
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,28 @@ Zep: Long-Term Memory for ‍AI Assistants.
## What is Zep? 💬
Zep is a long-term memory service for AI Assistant apps. With Zep, you can provide AI assistants with the ability to recall past conversations, no matter how distant, while also reducing hallucinations, latency, and cost.

### Installation Notes
Main branch contains the latest version of zep-cloud sdk. You can install it by running:
### Cloud Installation
You can install the Zep Cloud SDK by running:
```bash
npm install @getzep/zep-cloud
```
> [!NOTE]
> Zep Cloud [overview](https://help.getzep.com/concepts) and [cloud sdk guide](https://help.getzep.com/sdks).
Open Source Compatible SDK is available in the [oss](https://github.com/getzep/zep-js/tree/oss) branch, where you can also find Open Source compatible examples. You can install it by running:
### Community Installation
```bash
npm install @getzep/zep-js
```
> [!NOTE]
> Zep Community Edition [quick start](https://help.getzep.com/ce/quickstart) and [sdk guide](https://help.getzep.com/ce/sdks).
### Zep v0.x Compatible SDK
You can install Zep v0.x compatible sdk by running:
```bash
npm install @getzep/zep-js@^0.10.0
```
> [!NOTE]
> Zep v0.x [quick start](https://help.getzep.com/ce/legacy/deployment/quickstart) and [sdk guide](https://help.getzep.com/ce/legacy/sdk).
### How Zep works

Expand Down

0 comments on commit ba73bb0

Please sign in to comment.