Skip to content

Commit 648eacd

Browse files
authored
Updated readme file.
1 parent 03e279a commit 648eacd

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ A cross-platform library that makes it easy to create your own Match 3 game.
1010
- [Unity sample](#unity-sample)
1111
- [Terminal sample](#terminal-sample)
1212
- [Folder Structure](#cactus-folder-structure)
13+
- [Installation](#gear-installation)
1314
- [How To Use](#rocket-how-to-use)
1415
- [Add new icons set](#add-new-icons-set)
1516
- [Create animation job](#create-animation-job)
@@ -87,6 +88,55 @@ https://user-images.githubusercontent.com/28132516/164049550-467590dc-bbf8-4109-
8788
8889
├── Match3.sln
8990

91+
## :gear: Installation
92+
93+
Dependencies:
94+
- Match3-SDK: [UniTask](https://www.nuget.org/packages/UniTask/)
95+
- Unity Match3-SDK: [UniTask](https://openupm.com/packages/com.cysharp.unitask/)
96+
- Unity Match3-Sample: [UniTask](https://openupm.com/packages/com.cysharp.unitask/), [DOTween](https://openupm.com/packages/com.demigiant.dotween/) & [Match3-SDK](https://openupm.com/packages/com.chebanovdd.match3sdk/)
97+
98+
You can install Match3-SDK in one of the following ways:
99+
100+
<details><summary>1. Install via Package Manager</summary>
101+
<br />
102+
103+
The package is available on the [OpenUPM](https://openupm.com/packages/com.chebanovdd.match3sdk/).
104+
105+
- Open `Edit/Project Settings/Package Manager`
106+
- Add a new `Scoped Registry` (or edit the existing OpenUPM entry)
107+
108+
```
109+
Name package.openupm.com
110+
URL https://package.openupm.com
111+
Scope(s) com.cysharp.unitask
112+
com.chebanovdd.match3sdk
113+
```
114+
- Open `Window/Package Manager`
115+
- Select `My Registries`
116+
- Install `UniTask` and `Match3-SDK` packages
117+
118+
</details>
119+
120+
<details><summary>2. Install via Git URL</summary>
121+
<br />
122+
123+
You can add `https://github.com/ChebanovDD/Match3-SDK.git?path=src/Match3.UnityPackage/Assets/Plugins/Match3` to the Package Manager.
124+
125+
If you want to set a target version, Match3-SDK uses the `v*.*.*` release tag, so you can specify a version like `#v0.1.2`. For example `https://github.com/ChebanovDD/Match3-SDK.git?path=src/Match3.UnityPackage/Assets/Plugins/Match3#v0.1.2`.
126+
127+
> **Note:** Dependencies must be installed before installing the package.
128+
129+
</details>
130+
131+
### [Releases Page](https://github.com/ChebanovDD/Match3-SDK/releases)
132+
133+
- **Match3.SDK.zip** - to use the Match3-SDK outside of Unity (eg. just as a normal C# project)
134+
- **Match3.Unity.SDK.unitypackage** - contains Match3-SDK source code
135+
- **Match3.Unity.Sample.unitypackage** - contains the sample project for Unity
136+
- **com.chebanovdd.match3sdk-\*.tgz** - for installing the Match3-SDK [from a local tarball file](https://docs.unity3d.com/Manual/upm-ui-tarball.html)
137+
138+
> **Note:** Dependencies must be installed before installing the packages.
139+
90140
## :rocket: How To Use
91141
92142
### Add new icons set

0 commit comments

Comments
 (0)