diff --git a/README.md b/README.md index 79559b4..36549e8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# rust-template +# Rust Template + +[![Template](https://github.com/ahcodedev/rust-template/actions/workflows/template.yml/badge.svg?branch=main)](https://github.com/ahcodedev/rust-template/actions/workflows/template.yml) +[![gitleaks](https://img.shields.io/badge/protected%20by-gitleaks-blue)](https://github.com/gitleaks/gitleaks) Rust project template for [Copier](https://copier.readthedocs.io/). diff --git a/copier.yml b/copier.yml index fed15ce..751a80c 100644 --- a/copier.yml +++ b/copier.yml @@ -27,6 +27,16 @@ description: help: Short description of the project default: "" +github_owner: + type: str + help: GitHub user or organization that will host the repository (used for README badges) + default: "" + +github_repo: + type: str + help: GitHub repository name (used for README badges) + default: "{{ project_name }}" + copyright_year: type: str help: Year used in the LICENSE copyright line diff --git a/template/README.md.jinja b/template/README.md.jinja index 9505879..32a8e96 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -1,5 +1,8 @@ # {{ project_name }} +[![Rust](https://github.com/{{ github_owner }}/{{ github_repo }}/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/{{ github_owner }}/{{ github_repo }}/actions/workflows/rust.yml) +[![gitleaks](https://img.shields.io/badge/protected%20by-gitleaks-blue)](https://github.com/gitleaks/gitleaks) + {{ description }} ## Setup