Skip to content

Commit

Permalink
Update README and package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Bodix committed Dec 18, 2020
1 parent 7bb9e61 commit 81465aa
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Evolunity

![Unity version](https://img.shields.io/badge/unity-2018.4%2B-blue?logo=unity)

Well-designed package with useful scripting tools for Unity development​.

## Content
Expand All @@ -11,6 +13,7 @@ Well-designed package with useful scripting tools for Unity development​.
- Dictionary
- IEnumerable
- IComparable

- Unity types
- Animator
- Color
Expand All @@ -21,13 +24,15 @@ Well-designed package with useful scripting tools for Unity development​.
- Renderer
- Transform
- Vector

### Utilities
- Binary serializer
- Delay
- Performance meter
- Static coroutine
- String encryptor
- Regex patterns

### Unity components (some with cool inspectors)
- PeriodicBehaviour
- InputReader (drag, zoom, and click)
Expand All @@ -38,6 +43,7 @@ Well-designed package with useful scripting tools for Unity development​.
- DontDestroyOnLoad
- PlatformDependent
- Singleton

### Editor tools
- Constants generator (tags, layers, scenes, etc.)
- Useful menu items
Expand All @@ -49,7 +55,8 @@ Well-designed package with useful scripting tools for Unity development​.
Evolunity may receive breaking changes, so be sure to make a backup before updating the package.

## Install
Open `{ProjectFolder}/Packages/manifest.json` and add following line:

Open `{ProjectFolder}/Packages/manifest.json` and add the following line:
```
{
"dependencies":
Expand All @@ -61,18 +68,21 @@ Open `{ProjectFolder}/Packages/manifest.json` and add following line:
```

## Requirements

- Unity 2018.4+
- Git (added to **PATH** environment variable)
<br>*(You can try the lower version, but I haven't tested that)*

- Git
<br>*(Must be added to the **PATH** environment variable)*

## License

[**CC BY-ND 4.0**](https://creativecommons.org/licenses/by-nd/4.0/)

1. **You can use this package in commercial projects.**
1. **You can use this package in :heavy_dollar_sign:commercial:heavy_dollar_sign: projects.**

2. You can modify or extend this package only for your own use but you can't distribute modified version.
- **Note:** You can submit a pull request to this repository and if your change is useful, I'll be sure to add it!
2. You can modify or extend this package only for your own use but you can't distribute the modified version.
>**Note:** You can submit a pull request to this repository and if your change is useful, I'll be sure to add it!
3. You must indicate the author.
- **Note:** You don't need to take any further action on this point, because all credits is written at the head of the scripts!
>**Note:** You don't need to take any further action on this point, because all attributions are written at the head of the scripts!
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"displayName": "Evolunity",
"version": "1.0.0",
"unity": "2018.4",
"description": "Package with default tools for Unity development."
"description": "Well-designed package with useful scripting tools for Unity development."
}

0 comments on commit 81465aa

Please sign in to comment.