Skip to content

Commit b7e1691

Browse files
committed
Updated readme style
1 parent 29325aa commit b7e1691

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@
1616

1717
Constrained Rect is a small helper that aims to make it easier to create Rect's based on existing ones.
1818

19+
## Installation
20+
1. The package is available on the [openupm registry](https://openupm.com). You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
21+
```
22+
openupm add net.tnrd.constrainedrect
23+
```
24+
2. You can also install via git url by adding these entries in your **manifest.json**
25+
```json
26+
"net.tnrd.constrainedrect": "https://github.com/Thundernerd/Unity3D-ConstrainedRect.git"
27+
```
28+
29+
1930
## Usage
2031
Using constrained rects is easy. You simply call `Constrain.To(...)` and pass it either a `Rect` or an `EditorWindow`.
2132

@@ -66,21 +77,10 @@ After you've finalized your Constrained Rect by calling `.ToRect()` the Constrai
6677

6778
While all of this happens under the hood it is important to understand that from the moment that you call `.ToRect()` the Constrained Rect will throw an exception if it is not being used. This also means that if it is being used then the properties and variables might be different from what you might expect.
6879

80+
## Support
81+
**Constrained Rect** is a small and open-source utility that I hope helps other people. It is by no means necessary but if you feel generous you can support me by donating.
82+
83+
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J11GEYY)
6984

7085
## Contributing
7186
Pull requests are welcomed. Please feel free to fix any issues you find, or add new features.
72-
73-
## Installing
74-
Installing Constrained Rect into your Unity3D project is done through the [Package Manager](https://docs.unity3d.com/Manual/Packages.html).
75-
76-
You can either add the package manually to the [manifest.json](https://docs.unity3d.com/Manual/upm-dependencies.html) file:
77-
```json
78-
{
79-
"dependencies": {
80-
"net.tnrd.constrainedrect": "https://github.com/Thundernerd/Unity3D-ConstrainedRect.git"
81-
}
82-
}
83-
```
84-
85-
Or add it through the UI by selecting the **+ button** in the top left of the Package Manager, selecting _Add package from git URL..._, and pasting https://github.com/Thundernerd/Unity3D-ConstrainedRect.git in the input field.
86-

0 commit comments

Comments
 (0)