Add docs and make CatalogAssetManager public

Closes #1

.gitignore

@@ -26,8 +26,8 @@ Carthage
 # We recommend against adding the Pods directory to your .gitignore. However
 # you should judge for yourself, the pros and cons are mentioned at:
 # http://guides.cocoapods.org/using/using-cocoapods.html#should-i-ignore-the-pods-directory-in-source-control
-# 
+#
 # Note: if you ignore the Pods directory, make sure to uncomment
 # `pod install` in .travis.yml
 #
-# Pods/
+Example/Pods/

ColorAssetCatalog.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'ColorAssetCatalog'
-  s.version          = '0.3.0'
+  s.version          = '0.4.0'
   s.summary          = 'Adds iOS 9+ compatibility for named colors in asset catalogs.'
 
 # This description is used to generate tags and improve search results.

ColorAssetCatalog/Classes/ColorAssetManager.swift

@@ -5,17 +5,26 @@
 //  Created by Sam Rayner on 12/06/2017.
 //
 
-class ColorAssetManager {
-    static let shared = ColorAssetManager()
-    var catalogName = "Colors"
-    var cachingEnabled = true
+///Provides access to and caching of colors in an asset catalog.
+///For general use, use UIColor(asset:) rather than this class.
+public class ColorAssetManager {
+    ///The singleton instance to change settings on.
+    public static let shared = ColorAssetManager()
+
+    ///The name of the asset catalog to fetch colors from.
+    public var catalogName = "Colors"
+
+    ///Whether to cache colors in memory as they are accessed.
+    public var cachingEnabled = true
+
     var cgColors: [String: CGColor] = [:]
 
     private init() {
         NotificationCenter.default.addObserver(self, selector: #selector(clearCache), name: .UIApplicationDidReceiveMemoryWarning, object: nil)
     }
 
-    @objc func clearCache() {
+    ///Clear all used color objects from memory.
+    @objc public func clearCache() {
         cgColors.removeAll()
     }
 

ColorAssetCatalog/Classes/UIColor+ColorAssetCatalog.swift

@@ -6,6 +6,20 @@
 //
 
 public extension UIColor {
+    /**
+     Loads a color from an asset catalog.
+     On iOS 11 this aliases init(named:).
+     On iOS 9 or 10 this uses ColorAssetManager.
+
+     You can configure the asset catalog to look for colors:
+
+     ```
+     ColorAssetManager.shared.catalogName = "MyColors"
+     ```
+
+     - Parameter name: The name of the color in the asset catalog.
+     - Returns: A UIColor or nil if a color is not found of that name.
+     */
     public convenience init?(asset name: String) {
         if #available(iOS 11.0, *) {
             self.init(named: name)

Example/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - ColorAssetCatalog (0.3.0)
+  - ColorAssetCatalog (0.4.0)
 
 DEPENDENCIES:
   - ColorAssetCatalog (from `../`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  ColorAssetCatalog: 9c76c2cc967a38ee13dc05278edf86eedf82484f
+  ColorAssetCatalog: 1ba2a22174491585f217e4c8cb617221dd4ec8a2
 
 PODFILE CHECKSUM: 89fa1c485c40cfe868239bf0487f00e30a7e49da