Skip to content

Commit 2e34a03

Browse files
committed
docs: update readme
1 parent 40b896b commit 2e34a03

File tree

1 file changed

+107
-2
lines changed

1 file changed

+107
-2
lines changed

README.md

Lines changed: 107 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,110 @@
1-
unity-version
1+
unity-changeset
22
===
33

4-
Get/List Unity editor version and change-set
4+
Get/List Unity editor changeset
55

6+
[![npm](https://img.shields.io/npm/v/unity-changeset)](https://www.npmjs.com/package/unity-changeset)
7+
[![npm (beta)](https://img.shields.io/npm/v/unity-changeset/beta)](https://www.npmjs.com/package/unity-changeset/v/beta)
8+
![license](https://img.shields.io/npm/l/unity-changeset)
9+
![downloads](https://img.shields.io/npm/dy/unity-changeset)
10+
![release](https://github.com/mob-sakai/unity-changeset/workflows/release/badge.svg)
11+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
12+
13+
<br><br><br><br>
14+
15+
## Install
16+
17+
```sh
18+
npm install unity-changeset
19+
```
20+
21+
## Usage
22+
23+
As a node module:
24+
25+
```js
26+
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = require('unity-changeset');
27+
28+
(async () => {
29+
const changeset = await getUnityChangeset('2020.1.14f1');
30+
console.log(changeset);
31+
//=> UnityChangeset {version: '2020.1.14f1', changeset: 'd81f64f5201d'}
32+
console.log(changeset.toString());
33+
//=> 2020.1.14f1/d81f64f5201d
34+
const changesets = await scrapeArchivedChangesets();
35+
console.dir(changesets);
36+
//=> [UnityChangeset, UnityChangeset, ...]
37+
const betaChangesets = await scrapeBetaChangesets();
38+
console.log(betaChangesets);
39+
//=> [UnityChangeset, UnityChangeset, ...]
40+
})();
41+
```
42+
43+
As a command-line utility:
44+
45+
```sh
46+
# Install
47+
$ npm install -g unity-changeset
48+
49+
# Get changeset
50+
$ unity-changeset 2020.2.14f1
51+
d81f64f5201d
52+
53+
# List changesets
54+
$ unity-changeset --list
55+
2020.1.14f1 d81f64f5201d
56+
2020.1.13f1 5e24f28bfbc0
57+
2020.1.12f1 55b56f0a86e3
58+
...
59+
60+
# List changesets (beta)
61+
$ unity-changeset --list-beta
62+
2020.2.0b13/655e1a328b90
63+
2020.2.0b12/92852ae685d8
64+
2020.2.0b11/c499c2bf2e80
65+
...
66+
67+
# For more info, run with the `-h, --help` flag:
68+
$ unity-version -h
69+
```
70+
71+
<br><br><br><br>
72+
73+
## Contributing
74+
75+
### Issues
76+
77+
Issues are very valuable to this project.
78+
79+
- Ideas are a valuable source of contributions others can make
80+
- Problems show where this project is lacking
81+
- With a question you show where contributors can improve the user experience
82+
83+
### Pull Requests
84+
85+
Pull requests are, a great way to get your ideas into this repository.
86+
87+
### Support
88+
89+
This is an open source project that I am developing in my spare time.
90+
If you like it, please support me.
91+
With your support, I can spend more time on development. :)
92+
93+
[![](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)
94+
95+
<br><br><br><br>
96+
97+
## License
98+
99+
* MIT
100+
101+
## Author
102+
103+
* ![](https://user-images.githubusercontent.com/12690315/96986908-434a0b80-155d-11eb-8275-85138ab90afa.png) [mob-sakai](https://github.com/mob-sakai) [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai) ![GitHub followers](https://img.shields.io/github/followers/mob-sakai?style=social)
104+
105+
## See Also
106+
107+
* GitHub page : https://github.com/mob-sakai/unity-changeset
108+
* Releases : https://github.com/mob-sakai/unity-changeset/releases
109+
* Issue tracker : https://github.com/mob-sakai/unity-changeset/issues
110+
* Change log : https://github.com/mob-sakai/unity-changeset/blob/main/CHANGELOG.md

0 commit comments

Comments
 (0)