-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding maven badge to readme #381
Conversation
@stleary, it may finally make sense to have the markdown version. Having those "badges" at the top can be handy. |
@johnjaylward Agreed, a markdown readme would be a helpful improvement. |
@stleary Thanks for the quick feedback. I am happy to move the badge around and to make the class names bold. However there seems to be a convention to have the badges at / near the top. What do you think? I will not get to this until the end of the week anyway, so I'll check for more feedback and could then incorporate that too. |
@fleipold yes badge at the top is OK. |
171742b
to
b6efbab
Compare
@fliepold Apologies, I got out of sync on this. Please submit the pull request if you still want to commit this change. The updates you have described should be fine. |
@stleary No worries. To me it looks like this pull request is still up-to-date, so you should be able to merge it by clicking the merge button (you can also squash all the commits into one, I just made a lot of commits for clarity, but perhaps they shouldn't go to the master). The options how to merge a pull request are described here: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github |
Thanks for the refresher :) PR will be merged soon, pending comment window. |
What problem does this code solve? Risks Changes to the API? Will this require a new release? Should the documentation be updated? Does it break the unit tests? Was any code refactored in this commit? Review status |
This PR converts the README file to markdown and adds a maven badge, so that the latest version is immediately visible.
Somewhat like this:
It also adds a little bit of markdown syntax maintain a reasonable appearance (.md-files get rendered in non-fixed font by default).