haroldadmin / Vector

Kotlin Coroutines based MVI architecture library for Android
https://haroldadmin.github.io/Vector/
Apache License 2.0
193 stars 9 forks source link

Update the README to have simple working example #25

Closed kaushalyap closed 4 years ago

kaushalyap commented 4 years ago

Is your feature request related to a problem? Please describe. Current example in the README is not complete and incorrect (cannot get it to work using the example code).

Describe the solution you'd like Make the example on the README a working simple example. Something like counter example in MvRx

In addition please consider adding a module containing the working simple example to the repo.

haroldadmin commented 4 years ago

You're pointing out two separate issues here.

  1. Lack of a simple sample app
  2. Incomplete example in the project Readme.

For the first issue, i agree. We could use a simpler example app. Something like counter from MvRx would be perfect, but i don't want to have the exact same app. Perhaps something built using coroutines would be more apt.

For the second issue, I disagree. The point of the Readme example is to quickly show how an app in Vector might look like. It doesn't aim to be a full fledged example.

The only major things missing in the Readme example are complete Fragment setup, and implementation of the MessageProvider class. I think I'll just get rid of MessageProvider altogether, which should simplify things.

Either way, I'll try to implement these changes soon. Thanks for pointing them out :)

haroldadmin commented 4 years ago

Fixed with simpler readme example and simpler sample app. Thanks for raising this issue!