diff --git a/README.md b/README.md index a2f0b10..0f500a6 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# nothing-glyph-developer-kit-for-unity \ No newline at end of file +## NothingOS for Unity +This SDK provides native APIs for all of the essential Glyph features on Nothing Phone. + +## Features +- glyph-based progress bars +- custom glyph animations +- supports all range of distributed devices (Phone 1, Phone 2, Phone 2a) + +## What's inside? +- .NET wrapper for Unity +- native [Glyph Developer Kit](https://github.com/Nothing-Developer-Programme/Glyph-Developer-Kit) `.jar` library + +#### Unity Plugin +##### via Unity Package Manager +The latest version can be installed via [package manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) using following git URL: \ +`https://github.com/am1goo/NothingOS.Unity.git#1.0.0` + +## Requirements +- Minimal SDK 19 (Android 4.4, KitKat) + +## Limitations +This plugin works only on SDK 34 or newer (Android 14, Upside Down Cake), on other devices it just do nothing. + +## Tested in +- Unity 2019.4.x +- Unity 2020.3.x + +## Contribute +Contribution in any form is very welcome. Bugs, feature requests or feedback can be reported in form of Issues. \ No newline at end of file diff --git a/package.json b/package.json index 15c22dd..06e1b20 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "com.am1goo.nothing-glyph-developer-kit", + "name": "com.am1goo.nothingos.gdk", "version": "1.0.0", - "displayName": "Nothing Glyph Developer Kit", - "description": "Nothing Glyph Developer Kit for Unity", + "displayName": "NothingOS Glyph Developer Kit", + "description": "NothingOS Glyph Developer Kit for Unity", "unity": "2020.3", "license": "MIT", "licensesUrl": "https://raw.githubusercontent.com/am1goo/NothingOS.Unity/master/LICENSE", @@ -14,7 +14,7 @@ "animation", "sdk", "driver", - "london" + "london", "android" ], "author": {