Skip to content

Commit

Permalink
Update README.md of node.js
Browse files Browse the repository at this point in the history
  • Loading branch information
barshaul committed Jul 10, 2024
1 parent e73ad14 commit a868940
Showing 1 changed file with 1 addition and 64 deletions.
65 changes: 1 addition & 64 deletions node/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Valkey GLIDE

Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, and it supports all Valkey commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity.

## Supported Engine Versions

Expand All @@ -15,74 +14,12 @@ This preview release is recommended for testing purposes only.

## System Requirements

The beta release of Valkey GLIDE was tested on Intel x86_64 using Ubuntu 22.04.1, Amazon Linux 2023 (AL2023), and macOS 12.7.
In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/).

## NodeJS supported version

Node.js 16.20 or higher.

## Installation and Setup

### Installing via Package Manager (npm)

To install GLIDE for Redis using `npm`, follow these steps:

1. Open your terminal.
2. Execute the command below:
```bash
$ npm install @aws/glide-for-redis
```
3. After installation, confirm the client is installed by running:
```bash
$ npm list
myApp@ /home/ubuntu/myApp
└── @aws/[email protected]
```

## Basic Examples

#### Cluster Redis:

```node
import { GlideClusterClient } from "@aws/glide-for-redis";
const addresses = [
{
host: "redis.example.com",
port: 6379,
},
];
const client = await GlideClusterClient.createClient({
addresses: addresses,
});
await client.set("foo", "bar");
const value = await client.get("foo");
client.close();
```
#### Standalone Redis:
```node
import { GlideClient } from "@aws/glide-for-redis";
const addresses = [
{
host: "redis_primary.example.com",
port: 6379,
},
{
host: "redis_replica.example.com",
port: 6379,
},
];
const client = await GlideClient.createClient({
addresses: addresses,
});
await client.set("foo", "bar");
const value = await client.get("foo");
client.close();
```
## Documentation

Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations.
Expand Down

0 comments on commit a868940

Please sign in to comment.