com.vulpes.transitions - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

CHANGELOG.md

@@ -7,2 +7,11 @@ # Changelog
 
+## [1.0.3] - 2023-01-27
+### Changed
+- 'Transition_CanvasGroupAlpha' now has its 'start' and 'end' values clamped between 0.0 and 1.0.
+- 'TransitionGroup' now displays the total duration of the group including its 'delay' in its 'duration' field in the inspector.
+- Removed Text Mesh Pro Package as a dependency.
+
+### Added
+- Added Documentation.
+
 ## [1.0.2] - 2023-01-22
@@ -9,0 +18,0 @@ ### Changed

package.json

 {
   "name": "com.vulpes.transitions",
   "displayName": "Vulpes Transitions",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "unity": "2021.3",
-  "description": "A Promise driven Transition system for Unity.",
+  "description": "The Vulpes Transitions package is a Promise driven transition system that provides a number of components that can be used as a substitute for common animations such as moving a Transform between two points or fading a CanvasGroup in or out.",
   "keywords": [
@@ -19,6 +19,6 @@ "vulpes",
     "com.unity.ugui": "1.0.0",
-    "com.unity.textmeshpro": "2.0.1",
     "com.vulpes.promises": "2.1.1"
   },
-  "unityRelease": "0f1"
+  "unityRelease": "0f1",
+  "documentationUrl": "https://github.com/VulpesSoftware/com.vulpes.transitions/blob/master/Documentation~/index.md"
 }

README.md

 # Vulpes Transitions
 
-A Promise driven Transition system for Unity.
+The Vulpes Transitions package is a Promise driven transition system that provides a number of components that can be used as a substitute for common animations such as moving a Transform between two points or fading a CanvasGroup in or out.
+
+- [Documentation](https://github.com/VulpesSoftware/com.vulpes.transitions/blob/master/Documentation~/index.md)
+
+## Installing this package
+
+As of version 0.9.0-preview.1 of this package, you are now able to install it, along with other Vulpes Software packages via the Unity Package Manager. 
+
+In Unity 2019 LTS and Unity 2020 onwards you can install the package through 'Project Settings/Package Manager'. Under 'Scoped Registries' click the little '+' button and input the following into the fields on the right.
+
+*Name:* Vulpes Software
+*URL:* https://registry.npmjs.org
+*Scope(s):* com.vulpes
+
+Click 'Apply', now you should be able to access the Vulpes Software registry under the 'My Registries' section in the Package Manager window using the second dropdown in the top left.
+
+## Using this library
+
+To use this library efficiently you should first learn about Promises:
+
+- [Promises on Wikpedia](http://en.wikipedia.org/wiki/Futures_and_promises)
+- [Good overview](https://www.promisejs.org/)
+- [Mozilla](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43455

increased by30.86%

Dependency count

2

decreased by-33.33%

Number of package files

48

increased by29.73%

Number of lines in readme file

26

increased by550%

Dependency changes

• - Removedcom.unity.textmeshpro@2.0.1