Skip to content

Commit 3f68ca9

Browse files
authored
Please linter (#16)
1 parent de8bba4 commit 3f68ca9

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
`rke2diff` - Diff Rancher RKE2 releases! 🚀
44

55
**Notes:**
6+
67
* This tool uses the GitHub API to fetch releases. The API is rate-limited to 60 requests for unauthenticated requests. More info about rate limiting can be found [here](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28).
78

89
## Install
@@ -17,15 +18,20 @@
1718
### Download and run
1819

1920
1. Download (using `v0.1.3` as an example):
20-
```
21+
22+
```bash
2123
curl -LO https://github.com/mikejoh/rke2diff/releases/download/0.1.3/rke2diff_0.1.3_linux_amd64.tar.gz
2224
```
25+
2326
2. Unpack:
24-
```
27+
28+
```bash
2529
tar xzvf rke2diff_0.1.3_linux_amd64.tar.gz
2630
```
31+
2732
3. Run:
28-
```
33+
34+
```bash
2935
./rke2diff -version
3036
```
3137

@@ -35,21 +41,22 @@ tar xzvf rke2diff_0.1.3_linux_amd64.tar.gz
3541
rke2diff -h
3642
Usage of ./build/rke2diff:
3743
-per-page int
38-
Skip release candidate releases. (default 100)
44+
Skip release candidate releases. (default 100)
3945
-pick
40-
Interactive release picker.
46+
Interactive release picker.
4147
-releases
42-
Show all releases.
48+
Show all releases.
4349
-rke2 value
44-
RKE2 version to compare, can be set multiple times.
50+
RKE2 version to compare, can be set multiple times.
4551
-skip-rc
46-
Skip release candidate releases. (default true)
52+
Skip release candidate releases. (default true)
4753
-version
48-
Print the version number.
54+
Print the version number.
4955
```
5056

5157
Compare to version of RKE2:
52-
```
58+
59+
```bash
5360
rke2diff -rke2 v1.28.11+rke2r1 -rke2 v1.31.0+rke2r1
5461
┌──────────────────────────────────┬──────────────────────────────┬─────────────────────────────┐
5562
│ NAME │ V1.28.11+RKE2R1 (2024-07-01) │ V1.31.0+RKE2R1 (2024-09-04) │

0 commit comments

Comments
 (0)