Skip to content

Commit

Permalink
Node: fix docs
Browse files Browse the repository at this point in the history
Signed-off-by: Adar Ovadia <[email protected]>
  • Loading branch information
Adar Ovadia committed Sep 23, 2024
1 parent 1a535a8 commit c39b599
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 50 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@ Valkey General Language Independent Driver for the Enterprise (GLIDE), is an ope
## Supported Engine Versions
Valkey GLIDE is API-compatible with the following engine versions:

| Engine Type | 6.2 | 7.0 | 7.2 |
|-----------------------|-------|-------|-------|
| Valkey | - | - | V |
| Redis | V | V | V |
| Engine Type | 6.2 | 7.0 | 7.2 | 8.0 |
|-----------------------|-------|-------|-------|-------|
| Valkey | - | - | V | V |
| Redis | V | V | V | - |

## Current Status
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/valkey-io/projects/11).
In this release, Valkey GLIDE is available for Python, Java and Node, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/valkey-io/projects/11).

## Getting Started
- [Java](./java/README.md)
- [Python](./python/README.md)
- [Node](./node/README.md)
- [Documentation](https://github.com/valkey-io/valkey-glide/wiki)

## Getting Help
Expand Down
38 changes: 0 additions & 38 deletions csharp/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion java/client/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ publishing {
}
developers {
developer {
name = 'valkey-glide'
name = 'Valkey GLIDE Maintainers'
url = 'https://github.com/valkey-io/valkey-glide.git'
}
}
Expand Down
5 changes: 2 additions & 3 deletions node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valk

## Current Status

We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
This preview release is recommended for testing purposes only.
We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project [roadmap](https://github.com/orgs/valkey-io/projects/11). We welcome questions and contributions from all Valkey stakeholders.

# Getting Started - Node Wrapper

## System Requirements

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/).
In this release, Valkey GLIDE is available for Python, Java and Node. Support for GO 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/valkey-io/projects/11).

## NodeJS supported version

Expand Down
4 changes: 2 additions & 2 deletions node/npm/glide/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "${scope}${pkg_name}",
"types": "build-ts/index.d.ts",
"version": "${package_version}",
"description": "An AWS-sponsored, open-source Redis client.",
"description": "General Language Independent Driver for the Enterprise (GLIDE) for Valkey",
"main": "build-ts/index.js",
"module": "build-ts/index.js",
"type": "commonjs",
Expand All @@ -26,7 +26,7 @@
"client",
"valkey-glide"
],
"author": "Amazon Web Services",
"author": "Valkey GLIDE Maintainers",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/valkey-io/valkey-glide/issues"
Expand Down
2 changes: 1 addition & 1 deletion node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"typescript": "^5.5.4",
"uuid": "^10.0.0"
},
"author": "Valkey contributors",
"author": "Valkey GLIDE Maintainers",
"license": "Apache-2.0",
"publishConfig": {
"${registry_scope}registry": "https://registry.npmjs.org/",
Expand Down

0 comments on commit c39b599

Please sign in to comment.