Skip to content

Commit

Permalink
add getting started doc
Browse files Browse the repository at this point in the history
  • Loading branch information
flymedllva committed Dec 25, 2024
1 parent f9e778b commit b4fddfd
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,23 @@ The motivation to build Ristretto comes from the need for a contention-free cach

Ristretto is production-ready. See [Projects using Ristretto](#projects-using-ristretto).

## Getting Started

### Installing
To start using Ristretto, install Go 1.21 or above. Ristretto needs go modules. From your project, run the following command

```sh
$ go get github.com/dgraph-io/ristretto/v2
```
This will retrieve the library.

#### Choosing a version

Following these rules:

- v1.x.x is the first version used in most programs with Ristretto dependencies.
- v2.x.x is the new version with support for generics, for which it has a slightly different interface.
This version is designed to solve compatibility problems of programs using the old version of Ristretto. If you start writing a new program, it is recommended to use this version.

## Usage

Expand Down

0 comments on commit b4fddfd

Please sign in to comment.