Updated Readme

Author: bretleasure

.template.config/template.json

@@ -76,6 +76,13 @@
       "replaces": "<PackageProjectUrl>https://github.com/bretleasure/Inventor.AddinTemplate</PackageProjectUrl>",
       "defaultValue": ""
     },
+    "url2": {
+      "type": "parameter",
+      "datatype": "text",
+      "description": "project property url cleanup",
+      "replaces": "<RepositoryUrl>https://github.com/bretleasure/Inventor.AddinTemplate</RepositoryUrl>",
+      "defaultValue": ""
+    },
     "readme": {
       "type": "parameter",
       "datatype": "text",

Buttons/InventorButton.cs

@@ -65,7 +65,7 @@ internal InventorButton()
         /// <summary>
         /// Controls whether the button is enabled or not. If false, the button will be disabled (greyed out) and cannot be clicked.
         /// </summary>
-        public bool Enabled
+        public virtual bool Enabled
         {
             get => Definition.Enabled;
             set => Definition.Enabled = value;

Inventor.AddinTemplate.csproj

@@ -21,7 +21,6 @@
         <ContentTargetFolders>content</ContentTargetFolders>
         <NoWarn>$(NoWarn);NU5128</NoWarn>
         <NoDefaultExcludes>true</NoDefaultExcludes>
-        <Version />
         <RepositoryUrl>https://github.com/bretleasure/Inventor.AddinTemplate</RepositoryUrl>
 
 

README.md

@@ -1,15 +1,22 @@
 # Inventor Addin Template
 
+[![NuGet version (Inventor.AddinTemplate)](https://buildstats.info/nuget/Inventor.AddinTemplate)](https://www.nuget.org/packages/Inventor.AddinTemplate)
+
 ## Overview
 
-## Installation
+The goal of this template is to make crafting an Inventor addin as easy as possible. All that is required is to create the buttons and write the code that will be executed when the buttons are clicked. The template will handle adding the buttons to the ribbon.
+
+
+The template is designed to be used with Visual Studio or JetBrains Rider.
 
-### Visual Studio
+## Installation
 
-### JetBrains Rider
+The template can be installed using the dotnet CLI. The command to install the latest version can be found on the [NuGet.org page](https://www.nuget.org/packages/InventorAddinTemplate/).
 
 ## Usage
 
+Once the template is installed it will appear in the list of available project templates in Visual Studio and Rider.
+
 ### Addin Components
 
 These are the components that will be created when the addin is compiled.
@@ -20,11 +27,28 @@ The .addin file is the entry point for the addin. It is an XML file that describ
 
 The .addin file is a pointer to the .dll file. It is also used to specify the addin's name, description, and other properties.
 
-
 #### .dll File
 
 The .dll file is the compiled addin. It is a dynamic link library that contains the addin's code.
 
 ### Adding Buttons
 
-## Testing / Debugging
+Adding buttons is very simple. Just create a class that inherits the `InventorButton` class and implement the abstract methods. The `InventorButton` class will handle adding the button to the ribbon and executing the code when the button is clicked.
+
+All button classes in this project will be loaded into the Inventor UI. A button can be prevented from being loaded by overriding the `Enabled` property to return `false`.
+
+#### Execute Method
+
+This method is called when the button is clicked. This is where the code that the button will execute should be placed.
+
+#### Ribbon Tabs and Panels
+
+The `GetRibbonName()` and `GetRibbonPanelName()` methods are used to specify the tab and panel that the button will be added to. If the name matches the `InternalName` of an existing tab or panel the button will be added to that tab or panel. Otherwise a new tab or panel will be created.
+
+Internal names can be found using the [Inventor.InternalNames](https://www.nuget.org/packages/Inventor.InternalNames) package that is included with this template.
+
+#### Icon Resources
+
+Button icons need to be .PNG files and be added to the project as embedded resources.
+
+Check out the `DefaultButton` class for an example of how to add a button to the ribbon.