Skip to content

Commit bcd929c

Browse files
committed
docs: update readme
1 parent 72bec48 commit bcd929c

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ Get/List Unity editor changeset
1111

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

14+
## Key Features
15+
16+
- Get Unity editor changeset for specific versions
17+
- List archived and beta changesets
18+
- Available as Node.js module, Deno module, and CLI tool
19+
- Supports filtering, searching, and grouping of changesets
20+
- Integration with Unity Hub for installation
21+
22+
<br><br><br><br>
23+
1424
## Usage as a node module
1525

1626
Requirement: NodeJs 18 or later
@@ -257,6 +267,35 @@ $ /path/to/unity/hub -- --headless install \
257267

258268
<br><br><br><br>
259269

270+
## How to Develop
271+
272+
### Prerequisites
273+
274+
- [asdf](https://asdf-vm.com/) (for managing Deno/Node versions)
275+
276+
### Setup
277+
278+
1. Clone the repository:
279+
```sh
280+
git clone https://github.com/mob-sakai/unity-changeset.git
281+
cd unity-changeset
282+
```
283+
284+
2. Install dependencies:
285+
```sh
286+
asdf install
287+
deno install
288+
```
289+
290+
### Development Tasks
291+
292+
- Run tests: `deno task test`
293+
- Build the project: `deno task build`
294+
- Lint and format code: `deno task lint`
295+
- Run the CLI: `deno task run`
296+
297+
<br><br><br><br>
298+
260299
## Contributing
261300

262301
### Issues

0 commit comments

Comments
 (0)