README and LICENSE

Author: CodaFi

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014, TypeLift
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,80 @@
+[![Build Status](https://travis-ci.org/typelift/Swiftx.svg)](https://travis-ci.org/typelift/Swiftx)
+
+Swiftx
+======
+
+Swiftx is a Swift library containing functional abstractions and extensions to
+the Swift Standard Library.  Swiftz Core is a smaller and simpler way to introduce pure functional 
+datatypes into any codebase.
+
+Setup
+-----
+
+Swiftx can be included one of two ways:
+
+**Framework**
+
+- Drag `Swiftx.xcodeproj` or `Swiftx-iOS.xcodeproj` into your project tree as a subproject
+- Under your project's Build Phases, expand Target Dependencies
+- Click the + and add Swiftx
+- Expand the Link Binary With Libraries phase
+- Click the + and add Swiftx
+- Click the + at the top left corner to add a Copy Files build phase
+- Set the directory to `Frameworks`
+- Click the + and add Swiftx
+
+**Standalone**
+
+- Copy the swift files under `Swiftx/Swiftx` into your project.
+
+Introduction
+------------
+
+Swiftx provides a number of common data types and abstractions any codebase can utilize.
+
+A small example:
+
+```swiftz
+import Swiftx
+
+let str : String? = .Some("Hello ")
+let greeting = (+"World") <^> str // .Some("Hello World")
+```
+
+Seamless interaction with existing platform libraries is also possible with
+minimal effort:
+
+```swiftz
+import Foundation
+import struct Swiftx.Result
+
+/// result now contains either an array of file paths or the error generated by `NSFileManager`.
+let result : Result<[String]> = from({ ep in
+    let documentsDirectory : String = (NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true)[0] as String)
+    return (NSFileManager.defaultManager().contentsOfDirectoryAtPath(documentsDirectory, error: ep) as [String]?) ?? []
+})
+```
+
+
+Swiftx can even help with expressions of nothingness or errors:
+
+```swiftz
+import Swiftx
+
+/// We may not be able to do what we said we'd do, but this definition compiles. At runtime, 
+/// any code that invokes this function will immediately halt the program.
+func provePEqualsNP() -> Proof<P, NP> {
+    return undefined()
+}
+```
+
+System Requirements
+===================
+
+Swiftz and Swiftz Core support OS X 10.9+ and iOS 7.0+.
+
+License
+=======
+
+Swiftx is released under the BSD license.
+