Improved documentation and bump to version 0.3.0.

favoyang · Aug 7, 2019 · d90b1dd · d90b1dd
1 parent 2c3a9cb
commit d90b1dd
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,9 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2019-08-08
+ - Added context menu for faster asset import/update.
+
 ## [0.2.2] - 2019-08-05
  - Fixed simplified behavior.
  - Added unit tests.

diff --git a/Documentation~/AddressableImportSettings-ContextMenu.png b/Documentation~/AddressableImportSettings-ContextMenu.png
diff --git a/Documentation~/AddressableImportSettings-Create.png b/Documentation~/AddressableImportSettings-Create.png
diff --git a/Documentation~/AddressableImporter.md b/Documentation~/AddressableImporter.md
@@ -2,6 +2,8 @@
 
 You should create a single AddressableImportSettings file located at `Assets/AddressableAssetsData/AddressableImportSettings.asset`. To create it, go to `Assets/AddressableAssetsData` folder, right click in your project window and choose `Create > Addressable Assets > Import Settings`.
 
+![AddressableImportSettings Create](AddressableImportSettings-Create.png)
+
 Once the settings file selected, you can edit rules in the inspector window. Then click `File > Save Project` to apply the changes.
 
 ![AddressableImportSettings Inspector](AddressableImportSettings-Insepctor.png)
@@ -58,3 +60,9 @@ Similar to [Group Replacement](#group-replacement), address replacement is also
   - `Address Simplified` is ticked.
   - `Address Replacement` is in use.
   - In another word, if you intent to manually change the address later, leave `Address Simplified` unticked, `Address Replacement` blank, and do not use `Assets/` prefix for the customized address name.
+
+## Quick assets import
+
+You may have lots existing assets before using the importer. To quickly apply importer rules, right click the target folders and click context menu `AddressablesImporter: Check Folder(s)`. This is more efficient than reimport asset.
+
+![AddressableImport Context Menu](AddressableImportSettings-ContextMenu.png)
diff --git a/Editor/AddressableImporter.cs b/Editor/AddressableImporter.cs
@@ -131,8 +131,8 @@ static bool TryGetGroup(AddressableAssetSettings settings, string groupName, out
     /// </summary>
     public class FolderImporter
     {
-        [MenuItem("Assets/AddressablesImporter: Check sub folders")]
-        private static void DoSomethingWithVariable()
+        [MenuItem("Assets/AddressablesImporter: Check Folder(s)")]
+        private static void CheckFolders()
         {
             HashSet<string> filesToImport = new HashSet<string>();
             // Folders comes up as Object.
@@ -166,8 +166,8 @@ private static void DoSomethingWithVariable()
         }
 
         // Note that we pass the same path, and also pass "true" to the second argument.
-        [MenuItem("Assets/AddressablesImporter: Check sub folders", true)]
-        private static bool NewMenuOptionValidation()
+        [MenuItem("Assets/AddressablesImporter: Check Folder(s)", true)]
+        private static bool ValidateCheckFolders()
         {
             foreach (UnityEngine.Object obj in Selection.GetFiltered(typeof(UnityEngine.Object), SelectionMode.Assets))
             {

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "com.littlebigfun.addressable-importer",
   "displayName": "Unity Addressable Importer",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "unity": "2018.3",
   "description": "A simple rule based addressable asset importer.",
   "dependencies": {