diff --git a/README.md b/README.md index 7963f76..ef2dee7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,41 @@ -

Welcome to com.gameframe.async 👋

+

Gameframe.Async 👋

+ [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d2749fdbc70f422a9d1efccb56d48bff)](https://www.codacy.com/manual/coryleach/UnityAsync?utm_source=github.com&utm_medium=referral&utm_content=coryleach/UnityAsync&utm_campaign=Badge_Grade) ![version](https://img.shields.io/badge/version-1.0.3-blue.svg?cacheSeconds=2592000) [![openupm](https://img.shields.io/npm/v/com.gameframe.async?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.gameframe.async/) [![license](https://img.shields.io/github/license/coryleach/UnityAsync)](https://github.com/coryleach/UnityAsync/blob/master/LICENSE) [![twitter](https://img.shields.io/twitter/follow/coryleach.svg?style=social)](https://twitter.com/coryleach) + -> Async task utility package for Unity
-> Helper methods for starting tasks on the Unity thread.
-> Start and await coroutines from any thread.
+> Async task utility package for Unity +> Helper methods for starting tasks on the Unity thread. +> Start and await coroutines from any thread. + +## Quick Package Install + +#### Using UnityPackageManager (for Unity 2019.3 or later) +Open the package manager window (menu: Window > Package Manager)
+Select "Add package from git URL...", fill in the pop-up with the following link:
+https://github.com/coryleach/UnityAsync.git#1.0.4
+ +#### Using UnityPackageManager (for Unity 2019.1 or later) + +Find the manifest.json file in the Packages folder of your project and edit it to look like this: +```js +{ + "dependencies": { + "com.gameframe.async": "https://github.com/coryleach/UnityAsync.git#1.0.4", + ... + }, +} +``` + + + ## Quick Package Install @@ -72,16 +98,19 @@ await Awaiters.MainUnityThread; ``` + + ## Author 👤 **Cory Leach** -* Twitter: [@coryleach](https://twitter.com/coryleach) -* Github: [@coryleach](https://github.com/coryleach) +* Twitter: [@coryleach](https://twitter.com/coryleach) +* Github: [@coryleach](https://github.com/coryleach) + ## Show your support Give a ⭐️ if this project helped you! *** -_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ +_This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_ diff --git a/package.json b/package.json index f659737..50c732d 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,15 @@ { "name": "com.gameframe.async", "displayName": "Gameframe.Async", - "version": "1.0.3", - "description": "Async task utility library for Unity", + "version": "1.0.4", + "description": "> Async task utility package for Unity \n> Helper methods for starting tasks on the Unity thread. \n> Start and await coroutines from any thread.", "keywords": [], "author": { "name": "Cory Leach", "email": "cory.leach@gmail.com", - "url": "https://coryleach.info" - } + "url": "https://github.com/coryleach", + "github": "coryleach", + "twitter": "coryleach" + }, + "repositoryName": "UnityAsync" } \ No newline at end of file