Skip to content

Commit 55b8e5a

Browse files
committed
run updateReadme.sh
1 parent d0dc040 commit 55b8e5a

File tree

1 file changed

+5
-27
lines changed

1 file changed

+5
-27
lines changed

README.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Doing this, we also can generate typed tuples to use when resolving, thus allowi
1212

1313
## Installation
1414

15+
We aim to support carthage in the near future
16+
1517
### Cocoapods
1618

1719
Add
@@ -22,31 +24,14 @@ pod 'Swinject-CodeGen', :git => 'https://github.com/Swinject/Swinject-CodeGener
2224

2325
to your podfile.
2426

25-
### Carthage
26-
27-
Add
28-
29-
```
30-
github "Swinject/Swinject-CodeGeneration"
31-
```
32-
33-
to your Cartfile.
34-
3527
## Integration
3628
1. Define your dependencies in a .csv or .yml file (see below and example file)
3729
2. Add a call to generate the code as build script phase:
3830

39-
For Cocoapods:
4031
```Shell
4132
$PODS_ROOT/Swinject-CodeGen/bin/swinject_codegen -i baseInput.csv -o extensions/baseContainerExtension.swift
4233
```
4334

44-
For Carthage:
45-
```Shell
46-
$SRCROOT/Carthage/Checkouts/Swinject-CodeGen/bin/swinject_codegen -i baseInput.csv -o extensions/baseContainerExtension.swift
47-
```
48-
49-
5035
3. Add the generated file (here: `extensions/baseContainerExtension.swift`) to xcode
5136
4. Repeat if you need to support multiple targets/have multiple input files.
5237

@@ -114,22 +99,15 @@ We decided to use `;` as delimiter instead of `,` to allow the use of tuples as
11499
#### Additional Commands
115100
The ruby parser allows using `//` and `#` for comments.
116101
Empty lines are ignored and can be used for grouping.
117-
`#= <header>` can be used to specify additional headers, e.g. `#= import KeychainAccess`
118-
119-
#### Dictionaries and Arrays as Parameters
120-
When using typed dictionaries or arrays as parameters, use `Array<Type>` instead of `[Type]` and `Dictionary<TypeA, TypeB>` instead of `[TypeA:TypeB]`:
121-
122-
```CSV
123-
PersonType; InjectablePerson; initializer; additionalNames:Array<String>; family:Dictionary<String, String>;
124-
```
102+
`#= <header>` can be used to specify additional headers, e.g. `#ADD_HEADER import KeychainAccess`
125103

126104
### YML
127105

128106
Example for a .yml definition:
129107
```yml
130108
---
131-
DEPENDENCIES:
132-
- ADependency
109+
HEADERS:
110+
- import ADependency
133111
DEFINITIONS:
134112
- service: PersonType
135113
component: InjectablePerson

0 commit comments

Comments
 (0)