Update README, podspec

Author: davidisaaclee

README.md

@@ -1,29 +1,87 @@
 # VectorKit
 
-[![CI Status](http://img.shields.io/travis/David Lee/VectorKit.svg?style=flat)](https://travis-ci.org/David Lee/VectorKit)
-[![Version](https://img.shields.io/cocoapods/v/VectorKit.svg?style=flat)](http://cocoapods.org/pods/VectorKit)
-[![License](https://img.shields.io/cocoapods/l/VectorKit.svg?style=flat)](http://cocoapods.org/pods/VectorKit)
-[![Platform](https://img.shields.io/cocoapods/p/VectorKit.svg?style=flat)](http://cocoapods.org/pods/VectorKit)
+[![CI Status](http://img.shields.io/travis/David Lee/Vector.svg?style=flat)](https://travis-ci.org/David Lee/Vector)
+[![Version](https://img.shields.io/cocoapods/v/Vector.svg?style=flat)](http://cocoapods.org/pods/Vector)
+[![License](https://img.shields.io/cocoapods/l/Vector.svg?style=flat)](http://cocoapods.org/pods/Vector)
+[![Platform](https://img.shields.io/cocoapods/p/Vector.svg?style=flat)](http://cocoapods.org/pods/Vector)
 
 ## Usage
 
-To run the example project, clone the repo, and run `pod install` from the Example directory first.
+VectorKit provides a `Vector` protocol which can give any type the power to perform vector operations.
 
-## Requirements
+Here is a `CGPoint` extension, adopting the `Vector` protocol.
+
+```swift
+extension CGPoint: Vector {
+	// We need to specify the number of dimensions, so that the vector operations can be configured to fit the dimension.
+	public var numberOfDimensions: Int { return 2 }
+
+	// Every `Vector` can be initialized from a collection. This allows easy conversion among similar vector types.
+	public init<T where T: CollectionType, T.Generator.Element == CGFloat>(collection: T) {
+		var g = collection.generate()
+		guard let x = g.next(), let y = g.next() else {
+			fatalError()
+		}
+		self.init(x: x, y: y)
+	}
+
+	// `Vector` inherits from `CollectionType`, and internally leverages `CollectionType`'s methods for support
+	//   for multi-dimensional vectors.
+	public subscript(index: Int) -> CGFloat {
+		switch index {
+		case 0:
+			return x
+		case 1:
+			return y
+		default:
+			fatalError()
+		}
+	}
+}
+```
+
+Once we define this adoption, we can use all of `Vector`'s operations within `CGPoint`.
+
+```swift
+let pt1 = CGPoint(x: 3, y: 4)
+let pt2 = CGPoint(collection: [1, -2])
+
+pt1.magnitude == 5
+pt1 + pt2 == CGPoint(x: 4, y: 2)
+pt2 * 0.5 == CGPoint(x: 0.5, y: -1)
+-pt1 == CGPoint(x: -4, y: -2)
+```
+
+`Vector` also supports a handful of operations which can combine different kinds of `Vector`s. In the following example, both `CGPoint` and `CGSize` have adopted `Vector`.
+
+```swift
+let point = CGPoint(x: 1, y: -1)
+let size = CGSize(width: 5, height: 10)
+
+let pointDifference: CGPoint = point - size
+let sizeDifference: CGSize = point - size
+
+pointDifference == CGPoint(x: -4, y: -11)
+sizeDifference == CGSize(width: -4, height: -11)
+```
+
+## Running the tests
+
+To run the tests included in the example project, clone the repo, and run `pod install` from the Example directory first.
 
 ## Installation
 
-VectorKit is available through [CocoaPods](http://cocoapods.org). To install
+Vector is available through [CocoaPods](http://cocoapods.org). To install
 it, simply add the following line to your Podfile:
 
 ```ruby
-pod "VectorKit"
+pod "VectorKit", :git => "https://github.com/davidisaaclee/VectorKit.git"
 ```
 
 ## Author
 
-David Lee, aewofij@gmail.com
+David Lee, http://david-lee.net
 
 ## License
 
-VectorKit is available under the MIT license. See the LICENSE file for more info.
+Vector is available under the MIT license. See the LICENSE file for more info.

VectorKit.podspec

@@ -7,24 +7,26 @@
 #
 
 Pod::Spec.new do |s|
-  s.name             = "VectorKit"
-  s.version          = "0.1.0"
-  s.summary          = "A short description of VectorKit."
+	s.name             = "VectorKit"
+	s.version          = "0.1.0"
+	s.summary          = "Powerful vector operations for the types you're already using."
 
 # This description is used to generate tags and improve search results.
 #   * Think: What does it do? Why did you write it? What is the focus?
 #   * Try to keep it short, snappy and to the point.
 #   * Write the description between the DESC delimiters below.
 #   * Finally, don't worry about the indent, CocoaPods strips it!  
   s.description      = <<-DESC
+VectorKit gives you powerful vector operations for the types you're already using, by providing a Vector
+protocol which can give any type the power to perform vector operations.
                        DESC
 
-  s.homepage         = "https://github.com/<GITHUB_USERNAME>/VectorKit"
-  # s.screenshots     = "www.example.com/screenshots_1", "www.example.com/screenshots_2"
-  s.license          = 'MIT'
-  s.author           = { "David Lee" => "aewofij@gmail.com" }
-  s.source           = { :git => "https://github.com/<GITHUB_USERNAME>/VectorKit.git", :tag => s.version.to_s }
-  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
+	s.homepage         = "https://github.com/davidisaaclee/VectorKit"
+	# s.screenshots     = "www.example.com/screenshots_1", "www.example.com/screenshots_2"
+	s.license          = 'MIT'
+	s.author           = { "David Lee" => "david.isaac.lee@gmail.com" }
+	s.source           = { :git => "https://github.com/davidisaaclee/VectorKit.git", :tag => s.version.to_s }
+	# s.social_media_url = 'https://twitter.com/davidisaaclee'
 
   s.platform     = :ios, '8.0'
   s.requires_arc = true