Merge pull request #14 from AppCron/swift-package

Swift Package

Author: Florian Rieger

.gitignore

@@ -1,5 +1,5 @@
 
-# Created by https://www.gitignore.io/api/osx,xcode,swift
+# Created by https://www.gitignore.io/api/osx,swift,swiftpackagemanager
 
 ### OSX ###
 *.DS_Store
@@ -29,8 +29,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-
-### Xcode ###
+### Swift ###
 # Xcode
 #
 # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
@@ -55,31 +54,6 @@ xcuserdata/
 *.xccheckout
 *.xcscmblueprint
 
-
-### Swift ###
-# Xcode
-#
-# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
-
-## Build generated
-build/
-DerivedData/
-
-## Various settings
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
-xcuserdata/
-
-## Other
-*.moved-aside
-*.xcuserstate
-
 ## Obj-C/Swift specific
 *.hmap
 *.ipa
@@ -94,5 +68,40 @@ playground.xcworkspace
 #
 # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
 # Packages/
+# Package.pins
 .build/
 
+# CocoaPods
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# Pods/
+
+# Carthage
+#
+# Add this line if you want to avoid checking in source code from Carthage dependencies.
+# Carthage/Checkouts
+
+Carthage/Build
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/#source-control
+
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots
+fastlane/test_output
+
+### SwiftPackageManager ###
+Packages
+.build
+xcuserdata
+*.xcodeproj
+
+# End of https://www.gitignore.io/api/osx,swift,swiftpackagemanager

Package.swift

@@ -0,0 +1,7 @@
+import PackageDescription
+
+let package = Package(
+    name: "ACInteractor",
+    dependencies : [],
+    exclude: ["Tests"]
+)

README.md

@@ -4,7 +4,7 @@
 Swift Package for a Use Case centric architecture as proposed by Robert C. Martin and others.
 
 ## Overview
-ACInteractor is a Swift Package that supports a Use Case centric architecture and TDD in Swift projects. The basic idea is that one Use Case, and only one Use Case, is executed by a single class. As proposed by Robert C. Martin, these kind of classes are called Interactors.
+ACInteractor is a [Swift Package](https://swift.org/package-manager/) that supports a Use Case centric architecture and TDD in Swift projects. The basic idea is that one Use Case, and only one Use Case, is executed by a single class. As proposed by Robert C. Martin, these kind of classes are called Interactors.
 - Each Interactor has a Request model.
 - Each Interactor has a Response model.
 - Each Interactor has an Execute function that takes the Request model and returns the Response model.
@@ -50,15 +50,14 @@ ACInteractor
 ├── LICENSE
 ├── README.md
 ├── Sources     // The source files
-├── Tests       // The unit test files
-└── Xcode       // The Xcode project to run the test
+└── Tests       // The unit test files
 ```
 
 ## Setup
-Since Swift 3 and Swift Package are not available with a stable Xcode release, just add the Files of the **Sources** folder to your project.
+Since [Swift Package](https://swift.org/package-manager/) is not supporting iOS Xcode projects yet, it's recommended to add the files of the **Sources** folder directly to your project.
 
 ### via Git Submodule
-At the moment it's recommended to add the entire ACInteractor project as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to your repository.
+You can add the entire ACInteractor project as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to your repository.
 
 0. Navigate to the root directory of your Git repository in Terminal.
 0. Run the following command:  
@@ -68,7 +67,15 @@ At the moment it's recommended to add the entire ACInteractor project as a [Git
 0. Add the files of the **Sources** folder to your project.
 
 ### via Download
-Alternatively you can just download the files directly from Github and add the files of the *Sources* folder to your project.
+Alternatively you can just download the files directly from Github and add the files of the **Sources** folder to your project.
+
+### as Swift Package Dependency
+You can also add it as [Swift Package](https://swift.org/package-manager/) Dependency to another Swift Package.
+``` Swift
+dependencies: [
+    .Package(url: "https://github.com/AppCron/ACInteractor.git", majorVersion: 0)
+]
+```
 
 ## Writing Interactors
 ``` Swift

Tests/ErrorHandlerExtensionTests.swift …orTests/ErrorHandlerExtensionTests.swiftTests/ErrorHandlerExtensionTests.swift renamed to Tests/ACInteractorTests/ErrorHandlerExtensionTests.swift Tests/ErrorHandlerExtensionTests.swift renamed to Tests/ACInteractorTests/ErrorHandlerExtensionTests.swift

@@ -0,0 +1,6 @@
+import XCTest
+@testable import ACInteractorTests
+
+XCTMain([
+     testCase(ACInteractorTests.allTests),
+])