From b6cc3d180d1248adce69177d50f272a8edc90782 Mon Sep 17 00:00:00 2001 From: pgfm Date: Fri, 17 Jun 2022 21:49:39 -0500 Subject: [PATCH] Updated README to be useful. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 615674c..311fbad 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,21 @@ meager.io pre-commit hooks for Scala 3 development. Used to run `scalafmt` on commit. + +## Usage + +Create `.pre-commit-config.yaml` at the root of your repository: + +```yaml +--- +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.3.0 + hooks: + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://git.sr.ht/~eidolon/meager-pre-commit-scala + rev: v0.1.1 + hooks: + - id: scalafmt +```