update readme for pre-commit

robhowley · Aug 6, 2024 · a91c497 · a91c497
1 parent 139c479
commit a91c497
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,7 +1,6 @@
 name: CI
 on:
   push:
-  pull_request:
 
 jobs:
   test:

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Runs on [git pages](https://pages.github.com/) using [jekyll](https://jekyllrb.c
 
 ## Local dev
 
-Can run locally using docker compose. Run
+### Running site locally
 
 ```
 docker compose up
@@ -19,3 +19,11 @@ docker compose up
 and go to [localhost:4000](http://localhost:4000/). Changes to the _content_ will live reload.
 
 _Note_: changes to the `_config.yml`, e.g. theme, or the `Gemfile` will require restarting the container.
+
+### pre-commit
+
+The linting steps that run in CI are available as pre-commit checks as well. To set them up run
+
+```shell
+pre-commit install
+```