Skip to content

docs(NODE-7344): add experimental platform support to Readme #296

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
dariakp merged 5 commits into from
Dec 17, 2025
Merged

docs(NODE-7344): add experimental platform support to Readme #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02f08fc
docs(NODE-7344): add experimental platform suppor to Readme
PavelSafronov Dec 15, 2025
b7a15eb
pr feedback
PavelSafronov Dec 15, 2025
81797ce
Update etc/README.hbs
PavelSafronov Dec 16, 2025
b355ea1
regenerate docs
PavelSafronov Dec 16, 2025
8237122
pr feedback: added spacing to tables
PavelSafronov Dec 16, 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
26 changes: 17 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,28 @@ Now you can install `kerberos` with the following:
npm install kerberos
```

#### Support Strategy

There are two support tiers:

- **Tier 1**: These platforms represent the majority of our users. Test failures on tier 1 platforms will block
releases.
- **Experimental**: Test suite may not exist or may not pass. Test failures on experimental platforms
do not block releases. Contributions to improve support for these platforms are welcome.

#### Prebuild Platforms

Below are the platforms that are available as prebuilds on each github release.
`prebuild-install` downloads these automatically depending on the platform you are running npm install on.

- Linux GLIBC 2.28 or later
- s390x
- arm64
- x64
- MacOS universal binary
- x64
- arm64
- Windows
- x64
| Operating System | Platform | Support Type |
| ------------------------- | -------- | ------------ |
| Linux GLIBC 2.28 or later | s390x | Tier 1 |
| Linux GLIBC 2.28 or later | arm64 | Tier 1 |
| Linux GLIBC 2.28 or later | x64 | Tier 1 |
| MacOS universal binary | x64 | Tier 1 |
| MacOS universal binary | arm64 | Tier 1 |
| Windows | x64 | Tier 1 |

### Release Integrity

Expand Down
26 changes: 17 additions & 9 deletions etc/README.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,28 @@ Now you can install `kerberos` with the following:
npm install kerberos
```

#### Support Strategy

There are two support tiers:

- **Tier 1**: These platforms represent the majority of our users. Test failures on tier 1 platforms will block
releases.
- **Experimental**: Test suite may not exist or may not pass. Test failures on experimental platforms
do not block releases. Contributions to improve support for these platforms are welcome.

#### Prebuild Platforms

Below are the platforms that are available as prebuilds on each github release.
`prebuild-install` downloads these automatically depending on the platform you are running npm install on.

- Linux GLIBC 2.28 or later
- s390x
- arm64
- x64
- MacOS universal binary
- x64
- arm64
- Windows
- x64
| Operating System | Platform | Support Type |
| ------------------------- | -------- | ------------ |
| Linux GLIBC 2.28 or later | s390x | Tier 1 |
| Linux GLIBC 2.28 or later | arm64 | Tier 1 |
| Linux GLIBC 2.28 or later | x64 | Tier 1 |
| MacOS universal binary | x64 | Tier 1 |
| MacOS universal binary | arm64 | Tier 1 |
| Windows | x64 | Tier 1 |

### Release Integrity

Expand Down
Loading