Update README structure - Githubissues

flowkey / UIKit-cross-platform

Cross-platform Swift implementation of UIKit, mostly for Android

MIT License

598 stars 40 forks source link

Update README structure #255

Closed cshg closed 6 years ago

cshg commented 6 years ago

Type of change: Docs

Motivation

Rethink and discuss what's most important for developers who first look at the README.

Here some suggested changes to discuss in this PR:

After some feedback I think it makes sense to put How to run .. earlier and Architecture later.
Additionally adding a "Goal" section which explains the need for UIKit-cross-platform
Moving badges to the top and adding a subtitle "The missing part to make your Swift UI Code work on Android"