Skip to content

Commit

Permalink
remove pre req section and changed links
Browse files Browse the repository at this point in the history
  • Loading branch information
cyip10 committed Jun 28, 2024
1 parent 7651141 commit 2f73630
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In this release, GLIDE for Valkey is available for Python, Javascript (Node.js),

## Supported Valkey Versions

GLIDE for Valkey is API-compatible with open source Valkey version 6 and 7.
GLIDE for Valkey is API-compatible with open-source Valkey version 6 and 7.

## Current Status

Expand All @@ -22,13 +22,10 @@ This preview release is recommended for testing purposes only.

The beta release of GLIDE for Valkey was tested on Intel x86_64 using Ubuntu 22.04.1, Amazon Linux 2023 (AL2023), and macOS 12.7.

## Supported Operating Systems

GLIDE for Valkey is supported in Ubuntu, CentOS, and MacOS.

## Layout of Java code
The Java client contains the following parts:

1. `src`: Rust dynamic library FFI to integrate with [GLIDE core library](https://github.com/aws/glide-for-redis/blob/main/glide-core/README.md).
1. `src`: Rust dynamic library FFI to integrate with [GLIDE core library](./glide-core/README.md).
2. `client`: A Java-wrapper around the GLIDE core rust library and unit tests for it.
3. `examples`: An examples app to test the client against a Valkey localhost.
4. `benchmark`: A dedicated benchmarking tool designed to evaluate and compare the performance of GLIDE for Valkey and other Java clients.
Expand All @@ -42,16 +39,7 @@ At the moment, the Java client must be built from source.

#### Prerequisites

**Protoc installation**

Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases) and make it accessible in your $PATH by moving it or creating a symlink.
For example, on Linux you can copy it to `/usr/bin`:

```bash
sudo cp protoc /usr/bin/
```

Refer to Java's [DEVELOPER.md](https://github.com/aws/glide-for-redis/blob/main/java/DEVELOPER.md) for further instruction on how to set up your development environment.
Refer to Java's [DEVELOPER.md](./DEVELOPER.md) for further instruction on how to set up your development environment.

**Java version check**

Expand Down Expand Up @@ -143,7 +131,6 @@ public class Main {
}
}
}
}
```

### Cluster Valkey:
Expand Down

0 comments on commit 2f73630

Please sign in to comment.