Skip to content

Commit 98e8111

Browse files
authored
chore: update readme browser section with esm instructions
1 parent 497a7e0 commit 98e8111

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,27 @@ validate('v1.02'); // false
118118

119119
### Browser
120120

121+
In modern browsers the functions above can be imported as modules:
122+
123+
```html
124+
<script type="module">
125+
import { compareVersions, compare, satisfies, validate, validateStrict } from './node_modules/compare-versions/lib/esm/index.js'
126+
console.log(compareVersions('11.0.0', '10.0.0'))
127+
console.log(compare('11.0.0', '10.0.0', '>'))
128+
console.log(satisfies('1.2.0', '^1.0.0'))
129+
console.log(validate('11.0.0'))
130+
console.log(validateStrict('11.0.0'))
131+
</script>
132+
```
133+
134+
#### Legacy (UMD)
135+
121136
If included directly in the browser, the functions above are available on the global window under the `compareVersions` object:
122137

123138
```html
124-
<script src=https://unpkg.com/compare-versions/lib/umd/index.js></script>
139+
<script src="https://unpkg.com/compare-versions/lib/umd/index.js"></script>
125140
<script>
126-
const { compareVersions, compare, satisfies, validate } = window.compareVersions
141+
const { compareVersions, compare, satisfies, validate, validateStrict } = window.compareVersions
127142
console.log(compareVersions('11.0.0', '10.0.0'))
128143
console.log(compare('11.0.0', '10.0.0', '>'))
129144
console.log(satisfies('1.2.0', '^1.0.0'))

0 commit comments

Comments
 (0)