Update README to reflect latest changes

jazz-community / rtc-git-connector

Connect RTC work items with commits, issues, and requests from GitHub or GitLab

MIT License

6 stars 6 forks source link

Update README to reflect latest changes #26

Closed innerjoin closed 6 years ago

innerjoin commented 6 years ago

With a recent release, the UI has been overhauled and is now much cleaner. The README should be updated with new screen shots and feature description to meet the current implementation status

MartinBenninger commented 6 years ago

@innerjoin Please take a look at the new Wiki. It contains the latest documentation and screenshots.

I've also reduced the size of the readme now that the information is in the Wiki pages.

@innerjoin and @SBI- I'd be glad for any feedback on both the new wiki and the updated readme. Thanks!

innerjoin commented 6 years ago

@MartinBenninger Awesome, thanks a lot!

A few points:

Chapter 4 (Contributing) and 5 (Licensing) are now duplicated in the README and wiki. I would remove those chapters in the wiki
I would move the sentence This project contains detailed documentation and instructions in the Wiki. in the README to a separate section named 'Documentation' or 'Installation & Usage' to make sure that it is not over-read.

MartinBenninger commented 6 years ago

@innerjoin Good points, I agree.

I've made the changes and will now close this issue.