Skip to content

Commit d204061

Browse files
author
Florian Rieger
committed
Updated Readme.md to reflect Swift Package adjustments.
1 parent e67756e commit d204061

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Swift Package for a Use Case centric architecture as proposed by Robert C. Martin and others.
55

66
## Overview
7-
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.
7+
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.
88
- Each Interactor has a Request model.
99
- Each Interactor has a Response model.
1010
- Each Interactor has an Execute function that takes the Request model and returns the Response model.
@@ -50,15 +50,14 @@ ACInteractor
5050
├── LICENSE
5151
├── README.md
5252
├── Sources // The source files
53-
├── Tests // The unit test files
54-
└── Xcode // The Xcode project to run the test
53+
└── Tests // The unit test files
5554
```
5655

5756
## Setup
58-
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.
57+
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.
5958

6059
### via Git Submodule
61-
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.
60+
You can add the entire ACInteractor project as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to your repository.
6261

6362
0. Navigate to the root directory of your Git repository in Terminal.
6463
0. Run the following command:
@@ -68,7 +67,15 @@ At the moment it's recommended to add the entire ACInteractor project as a [Git
6867
0. Add the files of the **Sources** folder to your project.
6968

7069
### via Download
71-
Alternatively you can just download the files directly from Github and add the files of the *Sources* folder to your project.
70+
Alternatively you can just download the files directly from Github and add the files of the **Sources** folder to your project.
71+
72+
### as Swift Package Dependency
73+
You can also add it as [Swift Package](https://swift.org/package-manager/) Dependency to another Swift Package.
74+
``` Swift
75+
dependencies: [
76+
.Package(url: "https://github.com/AppCron/ACInteractor.git", majorVersion: 0)
77+
]
78+
```
7279

7380
## Writing Interactors
7481
``` Swift

0 commit comments

Comments
 (0)