Skip to content
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

Readme examples #2233

Merged
merged 4 commits into from
Oct 31, 2018
Merged

Readme examples #2233

merged 4 commits into from
Oct 31, 2018

Conversation

PyvesB
Copy link
Member

@PyvesB PyvesB commented Oct 29, 2018

  • removed build status as the real badge equivalent is displayed just above in the Readme.
  • replaced Code Climate by Codacy as the badges for the former service are unreliable (Some of Code Climate badges are not working #1518). Also, as Code Climate are not being very cooperative there is no point in giving them free advertising.
  • replaced Gratipay by Liberapay, its maintained fork.
  • added three new examples which showcase different usages of our badges.

I'm wondering though, why do we not insert real badge examples here? With a high maxAge parameter and static badges, it would probably put little extra load on the server.

@PyvesB PyvesB added the documentation Developer and end-user documentation label Oct 29, 2018
@shields-ci
Copy link

Messages
📖

✨ Thanks for your contribution to Shields, @PyvesB!

📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS

@chris48s
Copy link
Member

I'm 👍 on replacing them with static badge examples

@PyvesB
Copy link
Member Author

PyvesB commented Oct 30, 2018

The result can be viewed here.

@PyvesB PyvesB changed the title Readme examples update Readme examples Oct 30, 2018
@PyvesB PyvesB closed this Oct 31, 2018
@PyvesB PyvesB reopened this Oct 31, 2018
@PyvesB PyvesB merged commit cc84394 into badges:master Oct 31, 2018
@shields-deployment
Copy link

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants