Revamp README.md #133
Revamp README.md #133
Conversation
Draft pass at an updated readme, giving a bit more structure and reordering some of the information. There are a few areas that need to be fleshed out with more content, but seems like this may be a good starting foundation we can expand upon further.
| LiveKit for Swift is available as a Swift Package. | ||
| ### Requirements | ||
|
|
||
| ### Swift Package Manager |
There was a problem hiding this comment.
we now support Cocoapods too, would be great to document steps here.
There was a problem hiding this comment.
Oh, nice, yeah, let's do that.
| Delegates will be called on the SDK's internal thread. | ||
| Make sure any access to the UI is within the main thread, for example by using `DispatchQueue.main.async`. | ||
|
|
||
| # Memory management |
There was a problem hiding this comment.
I think these are quite useful, and I would place it further down in the details section.
Along with this, it would be good to have a section on how to keep the session running in the background (i.e. project settings, publish audio)
There was a problem hiding this comment.
Yeah, they're useful, I was thinking they could be on the wiki for the repo and perhaps linked to from the main README
There was a problem hiding this comment.
sure, that works. Just don't want to lose this. Memory management can be tricky for folks that are building real applications. If not careful, would lead to crashes/etc.
| ## iOS Usage | ||
|
|
||
| LiveKit provides an UIKit based `VideoView` class that renders video tracks. Subscribed audio tracks are automatically played. | ||
| ### Something Simple with SwiftUI |
There was a problem hiding this comment.
It can be placeholder, or it can be the actual title.
|
|
||
| Docs and guides are at [https://docs.livekit.io](https://docs.livekit.io). | ||
| <insert gif/image here /> |
There was a problem hiding this comment.
Yeah, happy to use a video that you record =)
Draft pass at an updated readme, giving a bit more structure and reordering some of the information. There are a few areas that need to be fleshed out with more content, but seems like this may be a good starting foundation we can expand upon further.