README updates

prepping for release fixing number/text in entry.tp
spdermn02 · May 23, 2022 · c383742 · c383742
1 parent d3d5ff8
commit c383742
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -3,9 +3,12 @@ Generate Dynamic Icons for Touch Portal based on Actions and 0-100% values.
 
 - [TouchPortal-Dynamic-Icons](#touchportal-dynamic-icons)
 - [Change Log](#change-log)
+- [What Is This?](#what-is-this)
 - [Actions](#actions)
   - [Simple Round Gauge](#simple-round-gauge)
+    - [Properties](#properties)
   - [Simple Bar Graph](#simple-bar-graph)
+    - [Properties](#properties-1)
 - [Sample Generator Uses](#sample-generator-uses)
   - [Simple Round Gauge - Usage from Events tab](#simple-round-gauge---usage-from-events-tab)
   - [Simple Bar Graph - Usage from Events tab](#simple-bar-graph---usage-from-events-tab)
@@ -24,6 +27,11 @@ v1.0.0 - Initial Release
     - Actions for Simple Round Gauge and Simple Bar Graph
 ```
 
+# What Is This?
+
+Do you find the need to render out a bar graph, or round gauge in Touch Portal, but it it needs to be dynamic. Look no further, this plugin can do that for you.
+This will draw bar graphs, or round gauges (simple styles only at first) based on your configured actions, colors, etc. (see Actions section for info), see Sample section for what you can do with it.
+
 # Actions
 
 Available Actions are
@@ -34,10 +42,30 @@ Available Actions are
 
 ![Simple Round Gauge](Resources/SimpleRoundGauge-Action.png)
 
+### Properties
+* Name: Can be any unique name for this image, it will become the State created by the plugin
+* Shadow: On or Off - do you want a light shadow behind your round gauge
+* Shadow Color: pick a color any color, only will display if Shadow is On
+* Indicator Color: Color of the main round gauge indicator
+* Highlight: On or Off - do you want a slight glow/highlight around the round guage (same color as indicator)
+* Starting At Degree: 180 (default) - can be any number 0 - 360, 0 is right middle of circle
+* Value: the value you want to represent - precentage 0 - 100
+* Cap Style: butt|round|square - What do you want the end of the indicator to look like (round looks best)
+* Background Color:  pick a color any color, if you want no background, set Opacity to 0 in the color selector
+* Direction: clockwise|counter clockwise - which way do you want the gauge to go around the circle.
+
 ## Simple Bar Graph
 
 ![Simple Bar Graph](Resources/SimpleBarGraph-Action.png)
 
+### Properties
+* Name: Can be any unique name for this image, it will become the State created by the plugin
+* Background: On or Off - do you want the graph on a background color
+* Background Color: pick a color any color, only will display if Background is On
+* Bar Color: pick a color any color, this is the color of the bars being drawn
+* Value: the value you want to represent - percentage 0 - 100
+* Bar Width: 10px (default) - any number of pixels you want the bar graph to look like, 1-256 px
+
 
 # Sample Generator Uses
 

diff --git a/base/TPDynamicIcons/entry.tp b/base/TPDynamicIcons/entry.tp
@@ -161,12 +161,12 @@
                         },
                         {
                             "id":"dynamic_icon_bar_graph_width",
-                            "type": "text",
+                            "type": "number",
                             "label":  "Bar Graph Width",
-                            "default": "1",
+                            "default": "10",
                             "allowDecimals":"false",
                             "minValue":"1",
-                            "maxValue":"4"
+                            "maxValue":"256"
                         }
 
                     ]