Skip to content

Commit 80e14cf

Browse files
committed
Add README
1 parent cba3f9f commit 80e14cf

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# AlexJS pre-commit mirror
2+
3+
Mirror of [AlexJS](https://alexjs.com) for [pre-commit](https://pre-commit.com).
4+
5+
## Using AlexJS with `pre-commit`
6+
7+
Example `.pre-commit.config.yml`:
8+
9+
```yaml
10+
repos:
11+
- repo: "https://github.com/mfisher87/alexjs-pre-commit-mirror"
12+
rev: "v11.0.1" # Use the sha / tag you prefer
13+
hooks:
14+
- id: "alex"
15+
```
16+
17+
## Continuous Integration
18+
19+
Two example ways to run AlexJS inclusive language checks in CI for your repository using
20+
your existing `pre-commit` configuration from the previous step:
21+
22+
* [The official pre-commit GitHub action](https://github.com/pre-commit/action): :rock:
23+
Very stable
24+
* [pre-commit.ci](https://pre-commit.ci): :zap: Faster, but has more frequent outages.

0 commit comments

Comments
 (0)