From 0c6b4ebae2a1a1c152ba49408677ddd6db84a76c Mon Sep 17 00:00:00 2001 From: Alex Usbergo Date: Mon, 8 May 2017 11:23:14 +0200 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 923aaed..2a8698d 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,34 @@ *A lightweight, operation based, multi-store Flux implementation in Swift.* +## Installation + +If you are using **CocoaPods**: + + +Add the following to your [Podfile](https://guides.cocoapods.org/using/the-podfile.html): + +```ruby +pod 'DispatchStore', '~> 0.1' +``` + +If you are using **Carthage**: + + +To install Carthage, run (using Homebrew): + +```bash +$ brew update +$ brew install carthage +``` + +Then add the following line to your `Cartfile`: + +``` +github "alexdrone/Dispatch" "master" +``` + +## Overview **Dispatch** is a [Flux](https://facebook.github.io/flux/docs/overview.html)-like implementation of the unidirectional data flow architecture in Swift. Flux applications have three major parts: the dispatcher, the stores, and the views.