Add convenience initializers so this adds more value and makes consuming programs simpler.

Author: luisdelarosa

README.md

@@ -5,6 +5,12 @@ This makes it easier to use LEDs with Swift.
 
 Here is a small example that will turn on an LED that is connected to GPIO pin 17 on a Raspberry Pi 3.
 ```
+let led = LED(gpioPin: .P17)
+led.value = 1
+```
+
+Here is a more verbose example, that is equivalent to the first example:
+```
 let gpios = SwiftyGPIO.GPIOs(for:.RaspberryPi3)
 let led = LED(gpioPin: .P17, swiftyGPIOs: gpios)
 led.value = 1

Sources/led.swift

@@ -26,11 +26,26 @@ public class LED {
         }
     }
 
-    public convenience init(gpioPin: GPIOName, forBoard board: SupportedBoard) {
+    
+    /**
+        Initializes a LED, the easy way.
+     
+        - Parameters:
+            - gpioPin: The pin that LED is connected to. Use a GPIOName type. Ex: .P17 for GPIO pin 17.
+            - board: The board that is supported. By default, it is a .RaspberryPi3.
+     */
+    public convenience init(gpioPin: GPIOName, forBoard board: SupportedBoard = .RaspberryPi3) {
         let swiftyGPIOs = SwiftyGPIO.GPIOs(for: board)
         self.init(gpioPin: gpioPin, swiftyGPIOs: swiftyGPIOs)
     }
-    
+
+    /**
+         Initializes a LED.
+         
+         - Parameters:
+             - gpioPin: The pin that LED is connected to. Use a GPIOName type. Ex: .P17 for GPIO pin 17.
+             - swiftyGPIOs: A dictionary created by SwiftyGPIO.GPIOs(for: .SupportedBoard).
+     */
     public init(gpioPin: GPIOName, swiftyGPIOs: [GPIOName: GPIO]) {
         self.gpioPin = gpioPin
 

Tests/ledTests/ledTests.swift

@@ -57,6 +57,15 @@ class LEDTests: XCTestCase {
     func testSimplerConstructor() {
         let led = LED(gpioPin: .P17, forBoard: .RaspberryPi3)
         XCTAssertTrue(led.isOff())
+        XCTAssertEqual(.P17, led.gpioPin)
+        XCTAssertNotNil(led.gpio)
+    }
+
+    func testSimplerConstructorWithDefaultRaspberryPi3Pins() {
+        let led = LED(gpioPin: .P17)
+        XCTAssertTrue(led.isOff())
+        XCTAssertEqual(.P17, led.gpioPin)
+        XCTAssertNotNil(led.gpio)
     }
 
     static var allTests = [