-
Notifications
You must be signed in to change notification settings - Fork 387
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
docs: make badges link to travis and pypi #528
Conversation
0dfa267
to
efe2975
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice PR, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's not merge until we resolve this...
README.md
Outdated
|
||
![Latest Version](https://img.shields.io/pypi/v/kazoo.svg) | ||
[![PyPI version](https://badge.fury.io/py/kazoo.svg)](https://badge.fury.io/py/kazoo) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand this last one:
- Why switch away from
shields.io
as the image source? - Why is the URL not pointing directly to PyPI? https://pypi.org/project/kazoo/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Didn't realize that it was a badge service (thought it was maybe just a static image host or something) until you mentioned it.
badge.fury.io
automatically redirects to PyPi kazoo. It's just the default way to use them as mentioned in their docs.
I've added a commit to switch back to shields.io and just fix the link instead after reading your comment though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The commits need to be squashed into a single one that matches the commit format. I am going to try do that during the merge, so approving.
Currently the badges just open a static image of the badges. This makes it so that it opens the actual links to latest travis build and PyPi instead.
Updated README.
For context: https://docs.travis-ci.com/user/status-images/ this is where I got the Travis link button command.
And https://badge.fury.io/for/py/kazoo for the PyPi badge.
Update: Moved to using shields.io like it was before instead of badge.fury. Here's the README with shields.io.