shieldify
| Crates.io | shieldify |
| lib.rs | shieldify |
| version | 0.1.3 |
| source | src |
| created_at | 2023-07-22 01:54:53.249492 |
| updated_at | 2023-09-22 23:19:32.318145 |
| description | A simple CLI tool to generate shields from info in Cargo.toml |
| homepage | https://github.com/JohnScience/shieldify |
| repository | https://github.com/JohnScience/shieldify |
| max_upload_size | |
| id | 922836 |
| size | 27,167 |
Dmitrii - Demenev (JohnScience)
documentation
https://docs.rs/shieldify
README
Shieldify
Add sheilds (=badges) to your README.md with ease.
Installation
cargo install shieldify
Usage
Add repository field to your Cargo.toml and run in the crate root:
shieldify
Your README.md will be updated with the badges.
Notes
For crates with src/lib.rs, it will also add a badge for the documentation.
At the moment of writing, the crate expects that the repository is hosted on GitHub.
In theory, the crate might eventually be able to use git2 to get the repository information from the local repository, but it is not implemented yet.
Related crates
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.