Skip to content

Commit c0e01ac

Browse files
docs(NODE-7344): add experimental platform support to Readme (#296)
Co-authored-by: Bailey Pearson <bailey.pearson@gmail.com>
1 parent 14bd969 commit c0e01ac

File tree

2 files changed

+34
-18
lines changed

2 files changed

+34
-18
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,28 @@ Now you can install `kerberos` with the following:
5555
npm install kerberos
5656
```
5757

58+
#### Support Strategy
59+
60+
There are two support tiers:
61+
62+
- **Tier 1**: These platforms represent the majority of our users. Test failures on tier 1 platforms will block
63+
releases.
64+
- **Experimental**: Test suite may not exist or may not pass. Test failures on experimental platforms
65+
do not block releases. Contributions to improve support for these platforms are welcome.
66+
5867
#### Prebuild Platforms
5968

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

63-
- Linux GLIBC 2.28 or later
64-
- s390x
65-
- arm64
66-
- x64
67-
- MacOS universal binary
68-
- x64
69-
- arm64
70-
- Windows
71-
- x64
72+
| Operating System | Platform | Support Type |
73+
| ------------------------- | -------- | ------------ |
74+
| Linux GLIBC 2.28 or later | s390x | Tier 1 |
75+
| Linux GLIBC 2.28 or later | arm64 | Tier 1 |
76+
| Linux GLIBC 2.28 or later | x64 | Tier 1 |
77+
| MacOS universal binary | x64 | Tier 1 |
78+
| MacOS universal binary | arm64 | Tier 1 |
79+
| Windows | x64 | Tier 1 |
7280

7381
### Release Integrity
7482

etc/README.hbs

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,28 @@ Now you can install `kerberos` with the following:
5555
npm install kerberos
5656
```
5757

58+
#### Support Strategy
59+
60+
There are two support tiers:
61+
62+
- **Tier 1**: These platforms represent the majority of our users. Test failures on tier 1 platforms will block
63+
releases.
64+
- **Experimental**: Test suite may not exist or may not pass. Test failures on experimental platforms
65+
do not block releases. Contributions to improve support for these platforms are welcome.
66+
5867
#### Prebuild Platforms
5968

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

63-
- Linux GLIBC 2.28 or later
64-
- s390x
65-
- arm64
66-
- x64
67-
- MacOS universal binary
68-
- x64
69-
- arm64
70-
- Windows
71-
- x64
72+
| Operating System | Platform | Support Type |
73+
| ------------------------- | -------- | ------------ |
74+
| Linux GLIBC 2.28 or later | s390x | Tier 1 |
75+
| Linux GLIBC 2.28 or later | arm64 | Tier 1 |
76+
| Linux GLIBC 2.28 or later | x64 | Tier 1 |
77+
| MacOS universal binary | x64 | Tier 1 |
78+
| MacOS universal binary | arm64 | Tier 1 |
79+
| Windows | x64 | Tier 1 |
7280

7381
### Release Integrity
7482

0 commit comments

Comments
 (0)