Skip to content

Commit 54900d8

Browse files
committed
📝 docs: improve UniTask installation UX with copyable URLs
1 parent d9b817e commit 54900d8

5 files changed

Lines changed: 35 additions & 41 deletions

File tree

Packages/com.soobak.algo.core/package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
"runner",
1414
"visualization"
1515
],
16-
"dependencies": {
17-
"com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask#2.5.3"
18-
},
16+
"dependencies": {},
1917
"samples": []
2018
}

Packages/com.soobak.algo.search/package.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
"algorithm",
1414
"visualization"
1515
],
16-
"dependencies": {
17-
"com.soobak.algo.core": "0.1.0",
18-
"com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask#2.5.3"
19-
},
16+
"dependencies": {},
2017
"samples": []
2118
}

Packages/com.soobak.algo.sorting/package.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,7 @@
1313
"algorithm",
1414
"visualization"
1515
],
16-
"dependencies": {
17-
"com.soobak.algo.core": "0.1.0",
18-
"com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask#2.5.3"
19-
},
16+
"dependencies": {},
2017
"samples": [
2118
{
2219
"path": "Samples~/SortingVisualizerDemo",

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,38 @@ Reusable Unity 6 algorithm pipeline. `com.soobak.algo.core` defines execution pr
1818
3. Consumers either pass an `ISortingAlgorithm` directly or call `ExecuteAsync("quick-sort", state, token)`.
1919
4. Each step broadcasts a cloned `SortingState` and a `SortOp` event so visualizers receive immutable snapshots.
2020

21-
1. Add the complete package from Git URL:
21+
## Installation
22+
23+
1. **Install UniTask first** (required dependency):
24+
25+
**Git URL (recommended):**
26+
```
27+
https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask#2.5.10
28+
```
29+
30+
**OpenUPM (alternative):**
31+
```
32+
https://openupm.com/packages/com.cysharp.unitask/
33+
```
34+
35+
2. **Add individual packages using path parameters**:
36+
37+
**Core Package:**
2238
```
23-
https://github.com/soo-bak/soobak-algo-core.git
39+
https://github.com/soo-bak/soobak-algo-core.git?path=Packages/com.soobak.algo.core
2440
```
2541

26-
2. Or add individual packages using path parameters:
42+
**Sorting Package:**
43+
```
44+
https://github.com/soo-bak/soobak-algo-core.git?path=Packages/com.soobak.algo.sorting
45+
```
46+
47+
**Search Package:**
48+
```
49+
https://github.com/soo-bak/soobak-algo-core.git?path=Packages/com.soobak.algo.search
50+
```
51+
52+
**Or add to manifest.json:**
2753
```json
2854
{
2955
"dependencies": {
@@ -33,6 +59,9 @@ Reusable Unity 6 algorithm pipeline. `com.soobak.algo.core` defines execution pr
3359
}
3460
}
3561
```
62+
63+
**Note**: Each package is independent and can be installed separately. Make sure to install UniTask first before using any algorithm packages.
64+
3665
2. Implement a visualizer.
3766
```csharp
3867
public sealed class BarVisualizer : IBarVisualizer {

package.json

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)