Skip to content
This repository was archived by the owner on Dec 19, 2025. It is now read-only.

Commit 8a06ef6

Browse files
committed
Add notes on browser support
1 parent 8dbafb1 commit 8a06ef6

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ This module may be require'd (CommonJS) or imported (ESM).
3737

3838
I do not plan on making this an ESM only module in the near future.
3939

40+
## Can I use this in the browser?
41+
42+
**Yes**, starting with version **3.1.0**.
43+
44+
[Go to the docs](https://axelrindle.github.io/github-version-checker/docs/next/browser-support/)
45+
for instructions.
46+
4047
## Install
4148

4249
```bash

docs/docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 4
33
sidebar_label: 🧩 API
44
---
55

docs/docs/browser-support.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 3
3+
sidebar_label: 🌐 Browser Support
4+
---
5+
6+
# Browser Support
7+
8+
To use this in the browser, install `@version-checker/browser` instead of `@version-checker/core`.
9+
10+
Subsequently, import `@version-checker/browser` instead of `@version-checker/core`.
11+
12+
**Note**: This is currently **EXPERIMENTAL**, as it depends on `@octokit/core^5.0.0-beta.4^` and the
13+
[Node.js Fetch API](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#fetch).

0 commit comments

Comments
 (0)