diff --git a/README.md b/README.md index 5298f08..ed99e16 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # copier-template-pre-commit-mirrors -This is a template for our pre-commit mirrors. +This is a template for our conda based pre-commit hooks. -To create a new mirror, you can run the following command +To create a new hook, you can run the following command ```bash -pixi run generate /path/to/mirror +pixi run generate /path/to/hook ``` diff --git a/pixi.toml b/pixi.toml index 144309d..0205064 100644 --- a/pixi.toml +++ b/pixi.toml @@ -1,6 +1,6 @@ [project] name = "copier-template-pre-commit-mirrors" -description = "Copier template for our pre-commit mirrors" +description = "Copier template for our conda based pre-commit hooks" authors = ["QuantCo "] channels = ["conda-forge"] platforms = ["osx-arm64", "osx-64", "linux-64"] diff --git a/template/README.md.jinja b/template/README.md.jinja index c2b4d7d..f427514 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -1,6 +1,6 @@ -# {{ tool }} mirror +# {{ tool }} pre-commit hook -Mirror of {{ tool }} for pre-commit with conda as a language. +pre-commit hook of {{ tool }} with conda as a `language` / package manager. For pre-commit: see [here](https://github.com/pre-commit/pre-commit)