Skip to content

Commit e5e313c

Browse files
committed
docs: update readme
1 parent c94c1b2 commit e5e313c

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ npm install unity-changeset
1919

2020
## Usage
2121

22-
As a node module:
22+
### As a node module:
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+
### As a command-line utility:
5353

5454
```
5555
Usage: Get a changeset for specific version
@@ -74,22 +74,22 @@ Options:
7474
# Install
7575
$ npm install -g unity-changeset
7676

77-
# Get a changeset for specific version
77+
# Get a changeset for specific version:
7878
$ unity-changeset 2020.2.14f1
7979
d81f64f5201d
8080

81-
# List changesets
81+
# List changesets:
8282
$ unity-changeset list
8383
2020.1.14f1 d81f64f5201d
8484
2020.1.13f1 5e24f28bfbc0
8585
2020.1.12f1 55b56f0a86e3
8686
...
8787

88-
# List changesets in json format
88+
# List changesets in json format:
8989
$ unity-changeset list --json
9090
[{"version":"2020.1.15f1","changeset":"97d0ae02d19d"},{"version":"2020.1.14f1","changeset":"d81f64f5201d"},...]
9191

92-
# List changesets in pretty json format
92+
# List changesets in pretty json format:
9393
$ unity-changeset list --pretty-json
9494
[
9595
{
@@ -103,36 +103,36 @@ $ unity-changeset list --pretty-json
103103
...
104104
]
105105

106-
# List changesets (beta)
106+
# List changesets (beta):
107107
$ unity-changeset list --beta
108108
2020.2.0b13 655e1a328b90
109109
2020.2.0b12 92852ae685d8
110110
2020.2.0b11 c499c2bf2e80
111111
...
112112

113-
# List the available Unity versions
113+
# List the available Unity versions:
114114
$ unity-changeset list --versions
115115
2020.1.14f1
116116
2020.1.13f1
117117
2020.1.12f1
118118
...
119119

120-
# List Unity 2018.3 or later, and 2019.1 or earlier
120+
# List Unity 2018.3 or later, and 2019.1 or earlier:
121121
$ unity-changeset list --min 2018.3 --max 2019.1
122122
2019.1.14f1 148b5891095a
123123
...
124124
2018.3.1f1 bb579dc42f1d
125125
2018.3.0f2 6e9a27477296
126126

127-
# List all Unity 2018.3 versions
127+
# List all Unity 2018.3 versions:
128128
$ unity-changeset list --grep 2018.3
129129
2018.3.14f1 d0e9f15437b1
130130
2018.3.13f1 06548a9e9582
131131
...
132132
2018.3.1f1 bb579dc42f1d
133133
2018.3.0f2 6e9a27477296
134134

135-
# List the available Unity minor versions
135+
# List the available Unity minor versions:
136136
$ unity-changeset list --minor-versions
137137
2020.1
138138
...
@@ -143,6 +143,21 @@ $ unity-changeset list --minor-versions
143143
$ unity-version -h
144144
```
145145

146+
### Install a specific version of Unity via UnityHub
147+
148+
```sh
149+
# /path/of/unity/hub/executor:
150+
# Windows: C:\\Program\ Files\\Unity\ Hub\\Unity\ Hub.exe
151+
# MacOS: /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub
152+
153+
# Show help:
154+
$ /path/of/unity/hub/executor -- --headless help
155+
156+
# Install Unity with iOS and Android modules:
157+
$ version=2020.1.14f1
158+
$ /path/of/unity/hub/executor install --no-sandbox --headless --version ${version} --changeset `unity-changeset ${version}` --module ios,android
159+
```
160+
146161
<br><br><br><br>
147162

148163
## Contributing

0 commit comments

Comments
 (0)