Merge pull request #256 from dansiegel/tasks/readme

update package readme
dansiegel · Jun 29, 2021 · 9b4839c · 9b4839c
2 parents bdf8dd5 + 822d05d
commit 9b4839c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 85 deletions.
diff --git a/docs/schemas/v2/buildtools.schema.json b/docs/schemas/v2/buildtools.schema.json
@@ -404,7 +404,7 @@
       }
     },
     "environment": {
-      "type": [ "object", "null" ]
+      "$ref": "#/definitions/EnvironmentSettings"
     },
     "debug": {
       "type": "boolean"

diff --git a/src/Mobile.BuildTools/ReadMe.txt b/src/Mobile.BuildTools/ReadMe.txt
@@ -1,86 +1,20 @@
 Thanks for installing the Mobile.BuildTools library!
 
-The Mobile.BuildTools are here to help you follow best practices when developing your mobile applications. If you've been around Mobile.BuildTools for a while A LOT has changed since version 1.0.
+The Mobile.BuildTools are here to help you follow best practices when developing your mobile applications. If you've been around Mobile.BuildTools for a while A LOT has changed since version 1.0. Please be sure to check out the new docs site at https://mobilebuildtools.com
 
-## Secrets
+If the Mobile.BuildTools is helping you deliver your app please consider becoming a GitHub Sponsor.
+https://github.com/sponsors/dansiegel
 
-Dealing with secrets is a pain in Mobile Apps. Secrets introduce a way to handle strongly typed configurations into your code at compile time. To add build secrets to your application simply add a file named secrets.json to the root of your project. This will generate a Secrets class in the temporary output (obj folder) at build time in the Helpers namespace.
-
-{
-  "Foo": "Bar",
-  "IsTrue": true,
-  "AnInt": 1,
-  "ADouble": 1.01
-}
-
-namespace YourRootNamespace.Helpers
-{
-    public static class Secrets
-    {
-        public const string Foo = "Bar";
-        public const bool IsTrue = true;
-        public const int AnInt = 1;
-        public const double ADouble = 1.01;
-    }
-}
-
-## Configuration Manager
-
-The Configuration Manager is new in Mobile.BuildTools 2.0. This was introduced from an idea from @ChaseFlorell. This is of course inspired from the typical app.config you might see on a traditional desktop app where you can simply drop in a new app.config and change how your app behaves without recompiling your app for a whole new environment. The ConfigurationManager is compiled for Xamarin Android, Xamarin iOS, Xamarin Mac, UWP, and is of course available for netstandard2.0 and netcoreapp.
-
-The Mobile.BuildTools includes a number of helpers here. When you have build specific configs such as app.debug.config or app.release.config it will automatically transform the app.config that is loaded into your app for the specific environment. It is key to understand that any app.config or app.{environment}.config you have in a platform head project will automatically be included as a native asset. This means you have the ability to bundle configs like:
-
-- app.qa1.config
-- app.qa2.config
-- app.stage.config
-- app.prod.config
-
-While for most applications it would never make any sense to bundle configs like this, there are scenarios where this make sense to change the configuration at runtime. Bundling multiple configs within your app is fully supported and you are able to transform or swap out configurations entirely.
-
-For more information and configuration settings be sure to check out the Wiki at:
-https://github.com/dansiegel/Mobile.BuildTools/wiki
-
-## Image & Icon Management
-
-One of the great new features in Mobile.BuildTools 2.0 is the fact that we now natively handle your image assets. You can now safely remove all of those images that just clutter up your project and aren't great for Git in the first place. So how does it work? Let's assume you have a folder structure like the following in the root of your solution:
-
-```
-- Images
-  - Shared
-  - iOS
-  - Android
-  - Dev
-  - Prod
-```
-
-Give this structure we might update our projects as follows:
-
-```xml
-<Project>
-  <PropertyGroup>
-    <ImageAssetsDirectory>..\..\Images\Shared;..\..\Images\iOS</ImageAssetsDirectory>
-  </PropertyGroup>
-  <PropertyGroup Condition=" $(Configuration) == 'Debug' >
-    <ImageAssetsDirectory>$(ImageAssetsDirectory);..\..\Images\Dev</ImageAssetsDirectory>
-  </PropertyGroup>
-  <PropertyGroup Condition=" $(Configuration) == 'Store' >
-    <ImageAssetsDirectory>$(ImageAssetsDirectory);..\..\Images\Prod</ImageAssetsDirectory>
-  </PropertyGroup>
-</Project>
-```
-
-Now when you build it will automatically pick up the images in any of the specified image folders.
-
-### Images on iOS
-
-Each platform is a little different and as such it will generate images based on how the platform works. When the Image targets run, it will scan your iOS project for App Icon Sets. The key here is that it is going to look for a matching output name and at the Contents.json for what actual outputs need to be created. If no icon set is found it will create them as more traditional Resources with a @1x, @2x, & @3x output. The @3x version will be the original size of the image in your Images folder.
+Be sure to subscribe to my YouTube channel for tips and tricks
+https://youtube.com/dansiegel
 
 ## App Wide Config
 
-You can provide a solution wide configuration. The solution wide configuration must be named buildtools.json
+Be sure to add a `buildtools.json` to your solution root directory.
 
 ```json
 {
+  "$schema": "https://mobilebuildtools.com/schemas/v2/buildtools.schema.json",
   "artifactCopy": {
     "disable": false // false by default
   },
@@ -90,7 +24,6 @@ You can provide a solution wide configuration. The solution wide configuration m
     "versionOffset": 100 // 0 by default
   },
   "css": {
-    "minify": false, // not actually supported by Xamarin.Forms
     "bundleScss": false // false by default
   },
   "images": {
@@ -99,27 +32,36 @@ You can provide a solution wide configuration. The solution wide configuration m
       "Images/Shared"
     ],
     // Conditional Directory are added to the directories above
+    // These can be either Build Configurations or Target Frameworks like iOS/Android
     "conditionalDirectories": {
       "Debug": [
         "Images/Debug"
       ],
       "Store": [
         "Images/Store"
+      ],
+      "Android": [
+        "Images/Android"
       ]
     }
   },
   "projectSecrets": {
     "Contoso": {
-      "AzureAdClientId": {
-        "type": "String"
-      },
-      "AzureAdScopes": {
-        "isArray": true,
-        "delimiter": ";"
-      }
-    },
-    "Contoso.Android": {
-      "AzureAdDataScheme": null // will use String by default
+      "properties": [
+        {
+          "name": "AzureAdClientId",
+          "type": "String"
+        },
+        {
+          "name": "AzureAdScopes",
+          "type": "String",
+          "isArray": true
+        },
+        {
+          "name": "Backend",
+          "type": "Uri"
+        }
+      ]
     }
   },
   "environment": {