Skip to content
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

[docs]: add versions table #177

Closed
wants to merge 2 commits into from
Closed

[docs]: add versions table #177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0416310
[docs]: add versions table
0x009922 Nov 13, 2023
5e6225a
[docs]: use LTS as `<sup>`
0x009922 Nov 13, 2023
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ The packages are published under the `@iroha2` scope into Iroha Nexus Registry.

Check out [Hyperledger Iroha 2 Tutorial](https://hyperledger.github.io/iroha-2-docs/) that introduces you to Iroha 2 concepts and features and provides you with a step-by-step guide for JavaScript/TypeScript.

## Versioning Table

Here is the mapping between Iroha versions and `@iroha2/data-model` package versions:

| `@iroha2/data-model` Version | Iroha Version |
| ---------------------------: | :------------------------------- |
| `^7.0` | `2.0.0-pre-rc.20` <sup>LTS</sup> |
| `^6.0` | `2.0.0-pre-rc.14` |
| `^5.0` | `2.0.0-pre-rc.13` |
| `^4.0` | `2.0.0-pre-rc.9` <sup>LTS</sup> |
| `^3.0`, `^2.0`, `~1.4` | `2.0.0-pre-rc.6` <sup>LTS</sup> |
| `~1.3` | `2.0.0-pre-rc.5` |
| `~1.2` | `2.0.0-pre-rc.4` |
| `~1.1` | `2.0.0-pre-rc.3` |
| `~1.0` | `2.0.0-pre-rc.2` |
| `0.5` | `2.0.0-pre-rc.1` |

**Note:** After version `1.2` versions of `@iroha2/data-model` and `@iroha2/client` packages are the same. E.g. for `@iroha/data-model` of version `1.2` the according version of `@iroha2/client` package is also `1.2`.

## Maintenance

Make sure you have installed **Node.js v16.17 or v18**. As for a package manager, this project uses [PNPM](https://pnpm.io/).
Expand Down