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

Commit 72d5f05

Browse files
committed
Update documentation
1 parent 604473c commit 72d5f05

2 files changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414

1515
While versions below 12.x are not officially tested they might work anyway.
1616

17+
## Is this ESM only?
18+
19+
**No.**
20+
21+
This module may be require'd (CommonJS) or imported (ESM).
22+
23+
I do not plan on making this an ESM only module in the near future.
24+
1725
## Install
1826

1927
```bash

docs/changelog/unreleased.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,29 @@ sidebar_position: 1
33
---
44

55
# 🔜 Unreleased
6+
## Added
7+
8+
- A brand new CLI interface for usage in non Node.js projects.
9+
10+
## Changed
11+
12+
- `undefined` is returned instead of `null` in case of no found updates.
13+
- The usage of the GraphQL API may be explicitly disabled by passing `false` for the `token`.
14+
- The GraphQL queries have been optimized in terms of stability and reliability.
15+
- Using [Octokit](https://github.com/octokit) under the hood.
16+
17+
## Removed
18+
19+
- The `reduceTraffic` option.
20+
- Official support for Node.js below version 12. Older version might work but are not tested.
21+
622
## Security
723

8-
- Bump minimist from 1.2.5 to 1.2.6 (#10).
24+
- Dependencies have been updated.
25+
- The project is officially built and released with Node.js 18.
26+
27+
## Other
28+
29+
- Documentation an other stuff is now hosted at https://axelrindle.github.io/github-version-checker/
30+
- Moved to TypeScript.
31+
- Using [Lerna](https://lerna.js.org/) for monorepo management.

0 commit comments

Comments
 (0)