Skip to content

Commit c078f76

Browse files
committed
docs: update readme
1 parent 91c79d2 commit c078f76

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Get/List Unity editor changeset
1111

1212
<br><br><br><br>
1313

14-
## Install
14+
## Usage as a node module
15+
16+
### Install
1517

1618
```sh
17-
npm install unity-changeset
19+
$ npm install unity-changeset
1820
```
1921

20-
## Usage
21-
22-
### As a node module:
22+
### Example
2323

2424
```js
2525
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = require('unity-changeset');
@@ -49,7 +49,7 @@ const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = re
4949
})();
5050
```
5151

52-
### As a command-line utility:
52+
## Usage as a command-line utility
5353

5454
```
5555
Usage: Get a changeset for specific version
@@ -68,17 +68,26 @@ Options:
6868
--beta List alpha/beta changesets
6969
--versions Output only the available Unity versions
7070
--minor-versions Output only the available Unity minor versions
71+
--latest-patch Output only the latest Unity patch versions
7172
```
7273

74+
### Install
75+
7376
```sh
74-
# Install
7577
$ npm install -g unity-changeset
78+
```
7679

7780
# Get a changeset for specific version:
81+
82+
```sh
7883
$ unity-changeset 2020.2.14f1
7984
d81f64f5201d
85+
```
86+
87+
88+
### Get a changeset for specific version
8089

81-
# List changesets:
90+
```sh
8291
$ unity-changeset list
8392
2020.1.14f1 d81f64f5201d
8493
2020.1.13f1 5e24f28bfbc0
@@ -155,8 +164,12 @@ $ unity-changeset list --minor-versions
155164
2017.2
156165
2017.1
157166

158-
# For more info, run with the `-h, --help` flag:
159-
$ unity-version -h
167+
# List the latest Unity patch versions:
168+
$ unity-changeset list --latest-patch
169+
2020.1.14f1 d81f64f5201d
170+
...
171+
2017.2.5f1 588dc79c95ed
172+
2017.1.5f1 9758a36cfaa6
160173
```
161174

162175
### Install a specific version of Unity via UnityHub

0 commit comments

Comments
 (0)