webern / cargo-readme

Generate README.md from docstrings
Other
355 stars 57 forks source link

Document supported badges #65

Open BartMassey opened 3 years ago

BartMassey commented 3 years ago

Right now the only way to discover which badges are supported in Cargo.toml is to carefully read the source.

The current list seems to be: "appveyor", "circle-ci", "gitlab", "travis-ci", "github", "codecov", "coveralls", "is-it-maintained-issue-resolution", "is-it-maintained-open-issues", "maintenance"

We could put these into the README. Better might be to support cargo readme --list-badges.

Either way, documentation on what each badge wants as text would also be helpful.

Let me know what you want to do and I'm happy to put together a PR.