Skip to content

docs: update readme versions #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
genaris merged 2 commits into from
Nov 28, 2025
Merged

docs: update readme versions #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b22244
docs: update readme versions
TimoGlastra Nov 27, 2025
e44da4b
docs(changeset): docs: update version compatibility in readme
TimoGlastra Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/pretty-stingrays-accept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@openwallet-foundation/askar-nodejs": patch
"@openwallet-foundation/askar-react-native": patch
---

docs: update version compatibility in readme
16 changes: 6 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Wrapper for Node.js and React Native around [https://github.com/openwallet-foundation/askar](askar)

## Requirements

This library requires and has been tested with Node.js version `18.x`, `20.x` and `22.x`, or React Native version `0.75.x` and `0.76.x`. Newer versions might also work, but they have not been tested.

## Setup

You can import all types and classes from the `@openwallet-foundation/askar-nodejs` or `@openwalletfoundation/askar-react-native` library:
Expand All @@ -21,10 +17,10 @@ const key = Key.fromSeed({ algorithm: KeyAlgs.Bls12381G1, seed });

## Version Compatibility

The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions:
The JavaScript wrapper is versioned independently from the native bindings. The following table shows the compatibility between the different versions. This library has been tested with specific Node.JS and React Native versions. Newer versions might also work, but they have not been tested.

| Askar | JavaScript Wrapper | React Native |
| ------ | ------------------ | ------------ |
| v0.2.9 | v0.1.x | - |
| v0.3.x | v0.2.x | - |
| v0.4.x | v0.3.x | 0.75, 0.76 |
| JavaScript Wrapper | Askar | React Native | Node.JS |
| ------------------ | ------ | ------------ | ---------- |
| v0.3.0 - v0.3.1 | v0.4.1 | - | - |
| v0.4.0 - v0.4.2 | v0.4.5 | 0.75 - 0.79 | 18, 20, 22 |
| v0.4.3 | v0.4.6 | 0.75 - 0.79 | 18, 20, 22 |