Skip to content

Commit dd232cd

Browse files
-Update README.md with setup instructions
1 parent ad0f1d3 commit dd232cd

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,35 @@ All items in the repository are grouped by use for a feature and are listed belo
88

99
## How to use this
1010

11+
You can use this in two different ways: downloading this repository or adding it to your project's Package Manager manifest.
12+
13+
Alternatively, you can pick and choose the scripts that you want by placing only these scripts in your project's `Assets` folder.
14+
15+
### Download
16+
17+
#### Setup
18+
Download or clone this repository into your project in the folder `Packages/com.unity.2d.tilemap.extras`.
19+
20+
### Package Manager Manifest
21+
1122
#### Requirements
1223
[Git](https://git-scm.com/) must be installed and added to your path.
1324

1425
#### Setup
1526
The following line needs to be added to your `Packages/manifest.json` file in your Unity Project under the `dependencies` section:
16-
"com.unity.2d.tilemap.extras": "https://github.com/Unity-Technologies/2d-extras.git#package_2019.2"
27+
"com.unity.2d.tilemap.extras": "https://github.com/Unity-Technologies/2d-extras.git#master".
1728

1829
### Tilemap
1930

20-
For use with Unity `2019.2.0a7` onwards.
31+
For use with Unity `2019.2.0f1` onwards.
32+
33+
Please use the `2019.1` branch or the `2019.1` tag for Unity 2019.1 versions.
2134

22-
Please use the `2018.2` branch for Unity 2018.2 versions.
35+
Please use the `2018.3` branch or the `2018.3` tag for Unity 2018.3 versions.
2336

24-
Please use the `2017` branch for earlier versions of Unity (from 2017.2 and up).
37+
Please use the `2018.2` branch or the `2018.2` tag for Unity 2018.2 versions.
2538

26-
Please use the `package` branch for Unity `2018.3.0f2` but as a Unity Package instead of a Unity Project.
39+
Please use the `2017` branch or the `2017` tag for earlier versions of Unity (from 2017.2 and up).
2740

2841
##### Brushes
2942

0 commit comments

Comments
 (0)