Skip to content

Commit 09aba0d

Browse files
committed
Updated readme
1 parent 62939eb commit 09aba0d

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This Framework wraps the figo Connect API endpoints in nicely typed Swift functions and types for your conveniece.
55

66
- We don't support Swift versions older than 3.0
7-
- We are working on support for other platforms than iOS
7+
- Supports iOS and macOS
88

99

1010
## figo Connect API
@@ -39,9 +39,6 @@ Integrate the framework into your project:
3939
* Select the Figo.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.
4040
* Add the Figo.framework to your target(s) in the "Embedded Binaries" sections
4141

42-
### Carthage
43-
44-
We are working on bringing back Carthage support
4542

4643
## Usage
4744

@@ -88,11 +85,20 @@ To be able to login and use the figo API a user is required.
8885
}
8986
}
9087

91-
### Enable logging
88+
### Logging
89+
90+
For now we have a very simple logging solution. By default logging is disabled. If you want to enable logging, you can pass a logger instance to the `FigoClient`.
91+
92+
let figo = FigoClient(logger: ConsoleLogger())
93+
94+
If you want control of what is logged or how, you can provide your own instance that conforms to the `Logger` protocol.
9295

93-
Since the `FigoClient` by default uses the default instance of `XCGLogger`, you can control logging from wherever you like. You can also provide your own `XCGLogger` instance in the initializer.
96+
public protocol Logger {
97+
var debug: (String) -> Void { get }
98+
var verbose: (String) -> Void { get }
99+
var error: (String) -> Void { get }
100+
}
94101

95-
XCGLogger.default.setup(level: .verbose, showFunctionName: false, showThreadName: false, showLevel: false, showFileNames: false, showLineNumbers: false, showDate: false, writeToFile: nil, fileLevel: .none)
96102

97103
## Endpoints
98104

0 commit comments

Comments
 (0)