Skip to content

Commit e8ef176

Browse files
committed
docs: update README
1 parent 9e4814d commit e8ef176

File tree

1 file changed

+50
-21
lines changed

1 file changed

+50
-21
lines changed

README.md

Lines changed: 50 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -92,29 +92,58 @@ deno install -A -f -n unity-changeset https://deno.land/x/unity_changeset/src/cl
9292
```
9393

9494

95-
### Display help
95+
### Help
9696

9797
```
98-
$ unity-changeset -h
99-
Usage: Get a changeset for specific version
100-
$ unity-changeset <version>
101-
102-
Usage: List changesets
103-
$ unity-changeset list [options]
104-
105-
Options:
106-
--min <version> Minimum version (included)
107-
--max <version> Maximum version (included)
108-
--grep <version> Grep version
109-
--json Output in json format
110-
--pretty-json Output in pretty json format
111-
--all List all changesets (alpha/beta included)
112-
--beta List alpha/beta changesets
113-
--versions Output only the available Unity versions
114-
--minor-versions Output only the available Unity minor versions
115-
--latest-patch Output only the latest Unity patch versions
116-
--oldest-patch Output only the oldest Unity patch versions
117-
--oldest-lifecycle Output only the latest lifecycle Unity patch versions
98+
Usage: unity-changeset <version>
99+
100+
Description:
101+
102+
Find Unity changesets.
103+
104+
Options:
105+
106+
-h, --help - Show this help.
107+
-V, --version - Show the version number for this program.
108+
```
109+
110+
```
111+
Usage: unity-changeset list
112+
113+
Description:
114+
115+
List Unity changesets.
116+
117+
Options:
118+
119+
-h, --help - Show this help.
120+
121+
Search options:
122+
123+
--all - Search all changesets (alpha/beta included)
124+
--pre-release, --beta - Search only pre-release (alpha/beta) changesets
125+
--lts - Only the LTS versions
126+
--xlts - Only the LTS/XLTS versions (require 'Enterprise' or 'Industry' license to install XLTS version)
127+
128+
Filter options:
129+
130+
--min <version> - Minimum version (included)
131+
--max <version> - Maximum version (included)
132+
--grep <regex> - Regular expression (e.g. '20(18|19).4.*')
133+
--latest-lifecycle - Only the latest lifecycle (default)
134+
--all-lifecycles - All lifecycles
135+
136+
Group options:
137+
138+
--latest-patch - The latest patch versions only
139+
--oldest-patch - The oldest patch versions in lateat lifecycle only (Conflicts: --latest-patch)
140+
141+
Output options:
142+
143+
--version-only, --versions - Outputs only the version (no changesets)
144+
--minor-version-only, --minor-versions - Outputs only the minor version (no changesets)
145+
--json - Output in json format
146+
--pretty-json - Output in pretty json format
118147
```
119148

120149

0 commit comments

Comments
 (0)