update readme about events

gizak / termui

Golang terminal dashboard

MIT License

13.07k stars 783 forks source link

update readme about events #191

Closed xuanjiazhen closed 5 years ago

xuanjiazhen commented 5 years ago

the description for events in readme is outdated after the rework . Event.Data no longer exists in the current version

cjbassi commented 5 years ago

You're right and that's something I'm aware of. My thinking was that the README should reflect the latest release of termui where events have not been reworked. But if someone wanted to use the latest commits to master, they would be free to do so but at their own risk.

I am open to feedback on this. I wasn't sure what the best strategy of making breaking changes was but this seemed fine to me at the time.

mou commented 5 years ago

Best strategy is to make Readme content relevant to revision of code associated with it. Eg. when you switch branches content of Readme updates according to source code in this revision

cjbassi commented 5 years ago

Hi, I figured updating the readme to the latest commit was the best decision so I went ahead and did that and I also added a wiki with some general info. Let me know if anyone has any more suggestions.