com.vulpes.menus - npm Package Compare versions

Comparing version 0.3.4-preview.1 to 0.3.5-preview.1

CHANGELOG.md

@@ -7,2 +7,6 @@ # Changelog
 
+## [0.3.5-preview.1] - 2020-11-21
+### Changed
+- Merged Sample Packages into one.
+
 ## [0.3.4-preview.1] - 2020-11-08
@@ -9,0 +13,0 @@ ### Changed

package.json

 {
   "name": "com.vulpes.menus",
   "displayName": "Vulpes Menu Framework",
-  "version": "0.3.4-preview.1",
+  "version": "0.3.5-preview.1",
   "unity": "2019.1",
@@ -24,12 +24,7 @@ "description": "A Promise driven game menu framework for Unity.",
     {
-      "displayName": "Basic UI Sprites",
-      "description": "A collection of simple UI Sprites that can be used when blocking out Menus. You can use them as is, or as placeholders when blocking out screens.",
-      "path": "Samples~/Basic UI Sprites"
-    },
-    {
-      "displayName": "Menu Templates",
+      "displayName": "Menu Samples",
       "description": "A collection of sample screens and widgets that demonstrate various menu framework implementations. You can use them as is, or as templates to build out your own screens and widgets.",
-      "path": "Samples~/Menu Templates"
+      "path": "Samples~/Menu Samples"
     }
   ]
 }

README.md

@@ -7,4 +7,16 @@ # Vulpes Menu Framework
 
-*NOTE:* This Package depends on '[com.vulpes.promises](https://github.com/VulpesSoftware/com.vulpes.promises.git#1.0.0)', due to current limitations of the Unity Package Manager you should install that package prior to installing this one to avoid errors.
+*NOTE:* This Package depends on '[com.vulpes.promises](https://github.com/VulpesSoftware/com.vulpes.promises.git#1.0.0)'.
 
+## Installing this pacakge
+
+As of version 0.3.4-preview.1 of this package, you are now able to install it, along with other Vulpes Sopfteware pacakges 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
@@ -11,0 +23,0 @@

New alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

463760

increased by0.02%

Number of lines in readme file

31

increased by63.16%

Worsened metrics

Number of package files

113

decreased by-0.88%

Lines of code

5

decreased by-54.55%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes