diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/Kommander.png b/Kommander.png new file mode 100644 index 0000000..339c603 Binary files /dev/null and b/Kommander.png differ diff --git a/Kommander.podspec b/Kommander.podspec index 91e9077..6f8dd0a 100644 --- a/Kommander.podspec +++ b/Kommander.podspec @@ -3,10 +3,10 @@ Pod::Spec.new do |s| s.version = '0.2.2' 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' => 'alejandro.ruperez@intelygenz.com', 'Juan Trías' => 'juan.trias@intelygenz.com', 'Roberto Estrada' => 'roberto.estrada@intelygenz.com' } - 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' diff --git a/LICENSE b/LICENSE index 5229b32..eac2d8c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,6 @@ -Copyright (c) 2017 Alex Rupérez +MIT License + +Copyright (c) 2017 Intelygenz 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. \ No newline at end of file diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..e197760 --- /dev/null +++ b/Package.swift @@ -0,0 +1,6 @@ +import PackageDescription + +let package = Package( + name: "Kommander" + origin: "com.intelygenz" +) \ No newline at end of file diff --git a/README.md b/README.md index e63b6d7..53f6d83 100644 --- a/README.md +++ b/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' => 'juan.trias@intelygenz.com', 'Roberto Estrada' => 'roberto.estrada@intelygenz.com' + +[alexruperez](https://github.com/alexruperez), alejandro.ruperez@intelygenz.com +[juantrias](https://github.com/juantrias), juan.trias@intelygenz.com +[RobertoEstrada](https://github.com/RobertoEstrada), roberto.estrada@intelygenz.com' + ## License Kommander is available under the MIT license. See the LICENSE file for more info. diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..3397c9a --- /dev/null +++ b/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-architect \ No newline at end of file