Update readme #199
Update readme #199
Conversation
README.md
Outdated
|
|
||
| ## Native Clients | ||
|
|
||
| LiveView Native enables native client frameworks such as the [LiveView Native SwiftUI Client](https://github.com/liveview-native/liveview-client-swiftui) and the [LiveView Native Jetpack Client (In Progress)](https://github.com/liveview-native/liveview-client-jetpack). |
There was a problem hiding this comment.
I think we should have a matrix of clients that we're listing include the html client
There was a problem hiding this comment.
That sounds good to me, but I'm not sure how you want that to look as a matrix 🤔
There was a problem hiding this comment.
Just a table maybe?
| UI Framework | Devices, | LiveView Client |
|---|---|---|
| SwiftUI | iPhone, iPad, AppleTV, Apple Watch, MacOS, Apple Vision Pro | LiveView Native SwiftUI |
| JetPack Compose | Android family | LiveView Native Jetpack |
There was a problem hiding this comment.
I made it a list of all of them. Let me know if that's not what you have in mind and how to improve it
There was a problem hiding this comment.
See the table above, let's go with that. You should be able to copy/paste that in and just add a HTML one as well
There was a problem hiding this comment.
@BrooklinJazz ☝️ can you change to the table form?
There was a problem hiding this comment.
Will do, sorry there was a desync issue when I asked the question so I hadn't seen the table
README.md
Outdated
|
|
||
| ### SwiftUI Client | ||
|
|
||
| To create your first LiveView Native LiveView, go to the [LiveView Native SwiftUI Client Usage](https://github.com/liveview-native/liveview-client-swiftui?tab=readme-ov-file#usage) guide on GitHub. Alternatively, you can read the [LiveView Native SwiftUI Documentation] where you can find documentation, examples, and interactive Livebook guides. |
There was a problem hiding this comment.
I don't see why we need to include client-specific sections in here, that's for those docs
There was a problem hiding this comment.
My thinking was it's not immediately obvious to someone new to LVN that these client libraries exist, or where to find resources for them.
There was a problem hiding this comment.
yeah I think the client matrix noted above should cover that. We can just link out to them
There was a problem hiding this comment.
I've removed them, but kept a list referencing them to improve discoverability.
|
Thanks! |
Small additions to the README to clarify: