io.extendreality.malimbe - npm Package Compare versions

Comparing version 9.6.0 to 9.6.1

CHANGELOG.md

 # Changelog
 
+### [9.6.1](https://github.com/ExtendRealityLtd/Malimbe/compare/v9.6.0...v9.6.1) (2019-10-28)
+
+#### Bug Fixes
+
+* **README.md:** provide more concise release data and update info ([9e87ea2](https://github.com/ExtendRealityLtd/Malimbe/commit/9e87ea295f6de7c03029a2e31de78fcdd9b29353))
+  > The Releases section has been removed and is now just a simple badge at the top of the README. There has been an additional section in `Getting Started` on how to update the package via the Unity Package Manager.
+  > 
+  > The links have also been ordered in the order of appearance in the document.
+
 ## [9.6.0](https://github.com/ExtendRealityLtd/Malimbe/compare/v9.5.3...v9.6.0) (2019-10-26)
@@ -4,0 +13,0 @@

package.json

@@ -5,3 +5,3 @@ {
     "description": "A collection of tools to simplify writing public API components in Unity.",
-    "version": "9.6.0",
+    "version": "9.6.1",
     "unity": "2018.1",
@@ -8,0 +8,0 @@ "keywords": [

README.md

@@ -6,2 +6,3 @@ [![Malimbe logo][Malimbe-Image]](#)
 
+[![Release][Version-Release]][Releases]
 [![License][License-Badge]][License]
@@ -16,13 +17,6 @@ [![Backlog][Backlog-Badge]][Backlog]
 
-## Releases
+## Getting Started
 
-| Branch  | Version                                          | Explanation                        |
-|---------|--------------------------------------------------|------------------------------------|
-| release | [![Release][Version-Release]][Releases]          | Stable, production-ready           |
-| preview | [![(Pre-)Release][Version-Prerelease]][Releases] | Experimental, not production-ready |
+### Adding the package to the Unity project manifest
 
-Releases follow the [Semantic Versioning (SemVer) system][SemVer].
-
-## Getting Started
-
 * Navigate to the `Packages` directory of your project.
@@ -77,2 +71,6 @@ * Adjust the [project manifest file][Project-Manifest] `manifest.json` in a text editor.
 
+### Updating to the latest version
+
+The package will show up in the Unity Package Manager UI once the above steps have been carried out. From then on the package can be updated by selecting the package in the Unity Package Manager and clicking on the `Update` button or using the version selection UI.
+
 ## Documentation
@@ -109,15 +107,15 @@
 [Malimbe-Image]: https://user-images.githubusercontent.com/1029673/48707109-4d876080-ebf6-11e8-9476-4f084246771d.png
+[Version-Release]: https://img.shields.io/github/release/ExtendRealityLtd/Malimbe.svg
 [License-Badge]: https://img.shields.io/github/license/ExtendRealityLtd/Malimbe.svg
 [Backlog-Badge]: https://img.shields.io/badge/project-backlog-78bdf2.svg
-[Version-Release]: https://img.shields.io/github/release/ExtendRealityLtd/Malimbe.svg
-[Version-Prerelease]: https://img.shields.io/github/release-pre/ExtendRealityLtd/Malimbe.svg?label=pre-release&colorB=orange
 
+[Releases]: ../../releases
+[License]: LICENSE.md
 [Backlog]: http://tracker.vrtk.io
-[Releases]: ../../releases
-[SemVer]: https://semver.org/
-[Latest-Release]: https://github.com/ExtendRealityLtd/Malimbe/releases/latest
-[VCS]: https://en.wikipedia.org/wiki/Version_control
-[UPM-Instructions]: https://docs.unity3d.com/Packages/com.unity.package-manager-ui@2.1/manual/index.html#extpkg
+
+[Unity]: https://unity3d.com/
+[Fody]: https://github.com/Fody/Fody
+[Latest-Release]: ../../releases/latest
 [FodyWeavers]: https://github.com/Fody/Fody#add-fodyweaversxml
-[Unity]: https://unity3d.com/
+[Documentation]: /Documentation/
 
@@ -127,10 +125,6 @@ [Fody's naming]: https://github.com/Fody/Fody#naming
 [Ploceidae]: https://en.wikipedia.org/wiki/Ploceidae
-[Fody]: https://github.com/Fody/Fody
 
-[Documentation]: /Documentation/
-[License]: LICENSE.md
-[ThirdPartyNotices]: THIRD_PARTY_NOTICES.md
-
 [Contributing guidelines]: https://github.com/ExtendRealityLtd/.github/blob/master/CONTRIBUTING.md
 [Unity project coding conventions]: https://github.com/ExtendRealityLtd/.github/blob/master/CONVENTIONS/UNITY3D.md
-[Code of Conduct]: https://github.com/ExtendRealityLtd/.github/blob/master/CODE_OF_CONDUCT.md
+[Code of Conduct]: https://github.com/ExtendRealityLtd/.github/blob/master/CODE_OF_CONDUCT.md
+[ThirdPartyNotices]: THIRD_PARTY_NOTICES.md

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

776586

increased by0.02%

Worsened metrics

Number of lines in readme file

125

decreased by-4.58%

No dependency changes