Skip to content

Commit 9211315

Browse files
authored
Update README.md
Readability tweaks, style corrections, remove CONTRIBUTING section in favour of CONTRIBUTING.md
1 parent c7543b6 commit 9211315

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To install the package, run:
2525
]
2626
```
2727

28-
## Get Baseline Widely available browser versions
28+
## Get Baseline Widely available browser versions or Baseline year browser versions
2929

3030
To get the current list of minimum browser versions compatible with Baseline Widely available features from the core browser set, call the `getCompatibleVersions()` function:
3131

@@ -79,7 +79,7 @@ Executed on 7th March 2025, the above code returns the following browser version
7979

8080
#### `targetYear`
8181

82-
The `targetYear` option returns the minimum browser versions compatible with all interoperable features at the end of the specific calendar year. For example, calling:
82+
The `targetYear` option returns the minimum browser versions compatible with all **Baseline Newly available** features at the end of the specified calendar year. For example, calling:
8383

8484
```javascript
8585
getCompatibleVersions({
@@ -116,7 +116,7 @@ Returns the following versions:
116116
117117
#### `widelyAvailableOnDate`
118118

119-
The `widelyAvailableOnDate` options returns the minimum versions compatible with Baseline Widely available on a specified date in the formay `YYYY-MM-DD`:
119+
The `widelyAvailableOnDate` option returns the minimum versions compatible with Baseline Widely available on a specified date in the formay `YYYY-MM-DD`:
120120

121121
```javascript
122122
getCompatibleVersions({
@@ -125,7 +125,7 @@ getCompatibleVersions({
125125
```
126126

127127
> [!TIP]
128-
> This can be particularly useful if you provide a versioned library that target Baseline Widely available on each version's release date and want to provide a table of minimum supported browsers in your documentation.
128+
> This option is useful if you provide a versioned library that targets Baseline Widely available on each version's release date and you need to provide a statement on minimum supported browser versions in your documentation.
129129
130130
#### `includeDownstreamBrowsers`
131131

@@ -141,7 +141,7 @@ For more information on downstream browsers, see [the section on downstream brow
141141

142142
#### `listAllCompatibleVersions`
143143

144-
If you need a list of all compatible versions, pass an object with the `listAllCompatibleVersions` :
144+
Setting `listAllCompatibleVersions` to true will include the minimum versions of each compatible browser, and all the subsequent versions:
145145

146146
```javascript
147147
getCompatibleVersions({
@@ -196,7 +196,7 @@ getAllVersions({
196196
});
197197
```
198198

199-
Downstream browsers include the same properties as core browsers, as well as the engine they use and which version of that engine they implement, for example:
199+
Downstream browsers include the same properties as core browsers, as well as the `engine`they use and `engine_version`, for example:
200200

201201
```javascript
202202
[
@@ -256,7 +256,7 @@ Shows UC Browser Mobile 13.8 implementing Chromium 100, and:
256256

257257
`Mozilla/5.0 (Linux; arm_64; Android 11; Redmi Note 8 Pro) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.6613.123 YaBrowser/24.10.2.123.00 SA/3 Mobile Safari/537.36`
258258

259-
Shows Yandex Browser Mobile 24.10 implementing Chromium 128. The Chromium version from this string is mapped to the main Chrome version from MDN `browser-compat-data`.
259+
Shows Yandex Browser Mobile 24.10 implementing Chromium 128. The Chromium version from this string is mapped to the corresponding Chrome version from MDN `browser-compat-data`.
260260

261261
> [!NOTE]
262262
> Where possible, approximate release dates have been included based on useragents.io "first seen" data. useragents.io does not have "first seen" dates prior to June 2020. However, these browsers' Baseline compatibility is determined by their Chromium version, so their release dates are more informative than critical.
@@ -284,7 +284,3 @@ This data is updated on a daily basis using a [script](https://github.com/web-pl
284284

285285
> [!NOTE]
286286
> All the non-core browsers currently included implement Chromium. Their inclusion in any of the above methods is based on the Baseline feature set supported by the Chromium version they implement, not their release date.
287-
288-
## Contributing
289-
290-
`baseline-browser-mapping` is part of the W3C WebDX Community Group's web-features project. To learn more about contributing to this module, see [CONTRIBUTING](/CONTRIBUTING.md).

0 commit comments

Comments
 (0)