Skip to content

Commit 4dd36ed

Browse files
authored
chore: update readme with generated api reference docs (#473)
1 parent 0ae0718 commit 4dd36ed

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,9 @@ If you’ve made it this far... Congrats!🎉
141141
*What’s next?*
142142
Try some other calls? Help us better understand what you think the most critical features are next. Run into any bugs? Give us feedback on the call-site interface. etc...
143143

144+
## API Reference documentation
145+
We recommend to use the documentation generation capabilities within Xcode (Option+Click on a symbol), but if you don't have Xcode available, you can view generated API reference documentation on our [github pages](https://awslabs.github.io/aws-sdk-swift/reference/0.x/).
146+
144147
## Logging
145148
The AWS SDK for Swift uses SwiftLog for high performant logging. Many of our calls are issued to the `debug` level of output, which are disabled in the console by default. To see debug output to your console, you can add the following code to your application in a place where you know that the code will be called once and only once:
146149
```swift
@@ -155,4 +158,4 @@ import ClientRuntime
155158
SDKLoggingSystem.add(logHandlerFactory: S3ClientLogHandlerFactory(logLevel: .debug))
156159
SDKLoggingSystem.add(logHandlerFactory: CRTClientEngineLogHandlerFactory(logLevel: .info))
157160
SDKLoggingSystem.initialize()
158-
```
161+
```

0 commit comments

Comments
 (0)