better documentation

0.1.5
AnthonyFSS · Dec 4, 2016 · 9adf0cf · 9adf0cf
1 parent 9c66224
commit 9adf0cf
Show file tree

Hide file tree

Showing 8 changed files with 271 additions and 263 deletions.
diff --git a/Example/LBTAComponents.xcodeproj/project.pbxproj b/Example/LBTAComponents.xcodeproj/project.pbxproj
@@ -507,7 +507,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 9.1;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
@@ -547,7 +547,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 9.1;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
@@ -563,7 +563,7 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				DEVELOPMENT_TEAM = 4HZZVGNXGK;
 				INFOPLIST_FILE = LBTAComponents/Info.plist;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 9.1;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				MODULE_NAME = ExampleApp;
 				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)";
@@ -580,7 +580,7 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				DEVELOPMENT_TEAM = 4HZZVGNXGK;
 				INFOPLIST_FILE = LBTAComponents/Info.plist;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 9.1;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				MODULE_NAME = ExampleApp;
 				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)";

diff --git a/Example/Podfile.lock b/Example/Podfile.lock
@@ -1,5 +1,5 @@
 PODS:
-  - LBTAComponents (0.1.0)
+  - LBTAComponents (0.1.5)
 
 DEPENDENCIES:
   - LBTAComponents (from `../`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  LBTAComponents: 405d85a834bba094a12fcbce2123825d4941f070
+  LBTAComponents: 1149ebd6489db9b646a773082b57828e908b4973
 
 PODFILE CHECKSUM: 5009b21af532c3c571f623efb87128d684a5bdd7
 

diff --git a/Example/Pods/Local Podspecs/LBTAComponents.podspec.json b/Example/Pods/Local Podspecs/LBTAComponents.podspec.json
diff --git a/Example/Pods/Manifest.lock b/Example/Pods/Manifest.lock
diff --git a/Example/Pods/Pods.xcodeproj/project.pbxproj b/Example/Pods/Pods.xcodeproj/project.pbxproj
diff --git a/Example/Pods/Target Support Files/LBTAComponents/Info.plist b/Example/Pods/Target Support Files/LBTAComponents/Info.plist
diff --git a/LBTAComponents.podspec b/LBTAComponents.podspec
@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'LBTAComponents'
-  s.version          = '0.1.2'
+  s.version          = '0.1.5'
   s.summary          = 'LBTAComponents is a small library of components that makes it easy to build applications programmatically.'
 
 # This description is used to generate tags and improve search results.
@@ -26,7 +26,7 @@ Pod::Spec.new do |s|
   s.source           = { :git => 'https://github.com/bhlvoong/LBTAComponents.git', :tag => s.version.to_s }
   s.social_media_url = 'https://twitter.com/buildthatapp'
 
-  s.ios.deployment_target = '10.0'
+  s.ios.deployment_target = '9.1'
 
   s.source_files = 'LBTAComponents/Classes/**/*'
 

diff --git a/README.md b/README.md
@@ -5,11 +5,47 @@
 [![License](https://img.shields.io/cocoapods/l/LBTAComponents.svg?style=flat)](http://cocoapods.org/pods/LBTAComponents)
 [![Platform](https://img.shields.io/cocoapods/p/LBTAComponents.svg?style=flat)](http://cocoapods.org/pods/LBTAComponents)
 
-## Example
+![LBTABanner](http://i.imgur.com/tTQOLtp.png)
+
+## Description
+LBTAComponents is a very simple library of components I use to build out production applications.  The ultimate goal of open sourcing this chunk of code is to speed up the teaching and recording process for all the tutorials on my YouTube channel [LetsBuildThatApp](https://www.youtube.com/letsbuildthatapp).
+
+## Why would you use this?
+This project is continuously evolving, but as of right now the important components are:
+
+1. **DatasourceController** - Think of this as UICollectionViewController on steroids.  No longer do we have to register cells with their own ids.  Providing a simple subclass of Datasource will render out the list items.
+2. **CachedImageView** - Loading images and caching them is quite tedious, this is my basic implementation that I'm providing. For more on image caching, watch my [tutorial](https://youtu.be/XFvs6eraBXM).
+3. **UIView anchors extension** - Let's face it, the amount of code required to place views onto the screen isn't great.  With this extension, you can anchor any view to any other view with just one line of code, albeit you need a few minutes to learn it.
+
+## Basic Example
+Here's how easy it is to render a list
+
+```swift
+import LBTAComponents
+
+class BasicController: DatasourceController {
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        let words = Datasource()
+        words.objects = ["Hello", "How", "are", "you", "today", "?"]
+        self.datasource = words
+    }
+
+}
+```
+
+![BasicController](http://imgur.com/92u2Mda.png)
+
+OK, so that's not a very interesting list you say. Providing some additional cell classes, you can easily modify your list to look like:
+![BasicHeaderCellFooterController](http://imgur.com/jq2wIIg.png)
+
+## How to Run the Examples
 
 To run the example project, clone the repo, and run `pod install` from the Example directory first.
 
 ## Requirements
+This project requires Xcode 7+ running a target of iOS 9.1+ along with Cocoapods.
 
 ## Installation
 
@@ -26,4 +62,4 @@ Brian Voong, [email protected]
 
 ## License
 
-LBTAComponents is available under the MIT license. See the LICENSE file for more info.
+LBTAComponents is available under the MIT license. See the LICENSE file for more info.