Open Source!

Kommander.podspec

@@ -3,10 +3,10 @@ Pod::Spec.new do |s|
   s.version          = '0.2.2-objc'
   s.summary          = 'A command pattern implementation written in Swift 3'
 
-  s.homepage         = 'https://gitlab.intelygenz.com/ios/kommander'
+  s.homepage         = 'https://github.com/intelygenz/Kommander-iOS'
   s.license          = { :type => 'MIT', :file => 'LICENSE' }
   s.author           = { 'Alex Rupérez' => '[email protected]', 'Juan Trías' => '[email protected]', 'Roberto Estrada' => '[email protected]' }
-  s.source           = { :git => 'https://gitlab.intelygenz.com/ios/kommander.git', :tag => s.version.to_s }
+  s.source           = { :git => 'https://github.com/intelygenz/Kommander-iOS.git', :tag => s.version.to_s }
 
   s.ios.deployment_target = '8.0'
 

LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2017 Alex Rupérez <[email protected]>
+MIT License
+
+Copyright (c) 2017 Intelygenz <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -7,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Package.swift

@@ -0,0 +1,6 @@
+import PackageDescription
+
+let package = Package(
+  name: "Kommander"
+  origin: "com.intelygenz"
+)

README.md

@@ -1,9 +1,31 @@
 # Kommander
 
-[![CI Status](http://img.shields.io/travis/intelygenz/Kommander-iOS.svg?style=flat)](https://travis-ci.org/intelygenz/Kommander-iOS)
+[![Twitter](https://img.shields.io/badge/contact-@intelygenz-0FABFF.svg?style=flat)](http://twitter.com/intelygenz)
 [![Version](https://img.shields.io/cocoapods/v/Kommander.svg?style=flat)](http://cocoapods.org/pods/Kommander)
 [![License](https://img.shields.io/cocoapods/l/Kommander.svg?style=flat)](http://cocoapods.org/pods/Kommander)
 [![Platform](https://img.shields.io/cocoapods/p/Kommander.svg?style=flat)](http://cocoapods.org/pods/Kommander)
+[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
+
+**Kommander** is a Swift library to manage the task execution in different threads. Through the definition a simple but powerful concept, [**Kommand**](https://en.wikipedia.org/wiki/Command_pattern).
+
+![Kommander](https://raw.githubusercontent.com/intelygenz/Kommander-iOS/master/Kommander.png)
+
+## Features
+
+- [x] Make kommand or multiple kommands
+- [x] Execute kommand or multiple kommands
+- [x] Cancel kommand or multiple kommands
+- [x] Set kommand success block
+- [x] Set kommand error block
+- [x] Main threat dispatcher
+- [x] Current threat dispatcher
+- [x] Custom OperationQueue dispatcher
+- [x] Custom DispatchQueue dispatcher
+- [x] Execute single or multiple Operation
+- [x] Execute sequential or concurrent blocks
+- [x] Execute DispatchWorkItem
+- [x] Swift 2 version
+- [x] Objective-C version
 
 ## Installation
 
@@ -17,15 +39,50 @@ pod 'Kommander'
 For Swift 2 compatibility use:
 
 ```ruby
-pod 'Kommander', :git => 'https://gitlab.intelygenz.com/ios/kommander.git', :tag => '0.2.2-swift2'
+pod 'Kommander', :git => 'https://github.com/intelygenz/Kommander-iOS.git', :tag => '0.2.2-swift2'
 ```
 
 For Objective-C compatibility use:
 
 ```ruby
-pod 'Kommander', :git => 'https://gitlab.intelygenz.com/ios/kommander.git', :tag => '0.2.2-objc'
+pod 'Kommander', :git => 'https://github.com/intelygenz/Kommander-iOS.git', :tag => '0.2.2-objc'
+```
+
+#### Or you can install it with [Carthage](https://github.com/Carthage/Carthage):
+
+```ogdl
+github "intelygenz/Kommander-iOS"
+```
+
+#### Or install it with [Swift Package Manager](https://swift.org/package-manager/):
+
+```swift
+dependencies: [
+    .Package(url: "https://github.com/intelygenz/Kommander-iOS.git")
+]
 ```
 
+## Usage
+
+```swift
+Kommander().makeKommand { () -> Void in
+    // Your code here
+}.execute()
+```
+
+## Etc.
+
+* Contributions are very welcome.
+* Attribution is appreciated (let's spread the word!), but not mandatory.
+
+## Authors
+
+'Juan Trías' => '[email protected]', 'Roberto Estrada' => '[email protected]'
+
+[alexruperez](https://github.com/alexruperez), [email protected]
+[juantrias](https://github.com/juantrias), [email protected]
+[RobertoEstrada](https://github.com/RobertoEstrada), [email protected]'
+
 ## License
 
 Kommander is available under the MIT license. See the LICENSE file for more info.

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect