diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..9e9a1b9 --- /dev/null +++ b/Installation.md @@ -0,0 +1,37 @@ +- Requires: + - iOS 8 SDK and above + - Swift 1.2 +- Dependencies: + - [GCDKit](https://github.com/JohnEstropia/GCDKit) + +### Install with Cocoapods +``` +pod 'CoreStore' +``` +This installs CoreStore as a framework. Declare `import CoreStore` in your swift file to use the library. + +### Install with Carthage +``` +github "JohnEstropia/CoreStore" >= 0.2.0 +``` + +### Install as Git Submodule +``` +git submodule add https://github.com/JohnEstropia/CoreStore.git +``` +Drag and drop **CoreStore.xcodeproj** to your project. + +#### To install as a framework: +Drag and drop **CoreStore.xcodeproj** to your project. + +#### To include directly in your app module: +Add all *.swift* files to your project. + + +## Contents +- [[Architecture]] +- [[Setting up]] +- [[Saving and processing transactions]] +- [[Fetching and querying]] +- [[Logging and error handling]] +- [[Observing changes and notifications]] \ No newline at end of file