Merge pull request #1 from RichAppz/commenting

Commenting on the public parameters

MacToggle/MacToggle.swift

@@ -95,11 +95,12 @@ class MacToggle: NSView {
         didSet { animate() }
     }
 
+    /// Change the toggle border on and off
     public var hasToggleBorder = true {
         didSet { circle.layer?.borderWidth = hasToggleBorder ? toggleBorderWidth : 0 }
     }
 
-    // MARK: Size Settings
+    /// Change the width of the outline border
     public var outlineWidth: CGFloat = 2 {
         didSet {
             backVw.layer?.borderWidth = outlineWidth
@@ -107,10 +108,12 @@ class MacToggle: NSView {
         }
     }
 
+    /// Change the width of the border on the toggle
     public var toggleBorderWidth: CGFloat = 2 {
         didSet { circle.layer?.borderWidth = hasToggleBorder ? toggleBorderWidth : 0 }
     }
 
+    /// Change the radius of the complete toggle
     public var radius: CGFloat {
         get {
             if let r = _radius { return r }
@@ -123,19 +126,22 @@ class MacToggle: NSView {
     }
 
 
-    // MARK: Color Settings
+    /// Change the color of the outline border
     public var outlineColor: NSColor = .lightGray {
         didSet { backVw.layer?.borderColor = outlineColor.cgColor }
     }
 
+    /// Change the color of the fill when the toggle is on
     public var fillColor: NSColor = .lightGray {
         didSet { if isOn { backVw.layer?.borderColor = fillColor.cgColor } }
     }
 
+    /// Change the color of the toggle center
     public var toggleColor: NSColor = .white {
         didSet { circle.backgroundColor = toggleColor }
     }
 
+    /// Change the background color of the complete toggle (visible when switch is off)
     public var backColor: NSColor = .white {
         didSet { backVw.backgroundColor = backColor }
     }

README.md

@@ -8,6 +8,8 @@
 
 Create Mac OS toggles with the user interaction, desisn and animation of the iOS UISwitch. Completely configurable through quick understandable code. With access to the source, you are able to add more custom features if you want. If their are any tweaks that you feel should be enabled then send me over a PR and I will have a look. **Swift 3 Ready**
 
+<center>![Banner](Resources/mactoggle.gif)</center>
+
 ##Setup
 
 Nothing complicated, download the MacToggle.swift file and add it to your project.
@@ -24,7 +26,7 @@ let toggle: MacToggle = {
 	return view
 }()
 ```
-There a plenty of settings you can play with, have fun and create the designs that you require for your Mac OS developments. Here are a couple of designs, for some ideas:
+There are plenty of settings you can play with, have fun and create the designs that you require for your Mac OS developments. Here are a couple of designs, for ideas:
 
 <br>