Skip to content

Commit 02bd443

Browse files
Add docs archive generation guide to README.md (#1031)
1 parent 5f7faa6 commit 02bd443

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@ The SwiftUI SDK offers three types of components:
3939
- Stateful components - Offer more customization options and possibility to inject custom views. Also fairly simple to integrate, if the extension points are suitable for your chat use-case. These components come with view models.
4040
- Stateless components - These are the building blocks for the other two types of components. In order to use them, you would have to provide the state and data. Using these components only make sense if you want to implement completely custom chat experience.
4141

42+
## Documentation Generation
43+
44+
To generate the documentation for SwiftUI StreamChat SDK, run the following command:
45+
46+
```bash
47+
xcodebuild docbuild -skipMacroValidation -skipPackagePluginValidation -derivedDataPath .derivedData -scheme StreamChatSwiftUI -destination generic/platform=iOS | xcpretty
48+
open .derivedData/Build/Products/Debug-iphoneos/StreamChatSwiftUI.doccarchive
49+
```
50+
51+
This will build the documentation archive and automatically open it in Xcode.
52+
4253
## Free for Makers
4354

4455
Stream is free for most side and hobby projects. You can use Stream Chat for free if you have less than five team members and no more than $10,000 in monthly revenue.

0 commit comments

Comments
 (0)