@evilmartians/lefthook-installer 1.4.10 → 1.4.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
<img align="right" width="147" height="100" title="Lefthook logo"
|
|
9
9
|
src="./logo_sign.svg">
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
A Git hooks manager for Node.js, Ruby and many other types of projects.
|
|
12
12
|
|
|
13
13
|
* **Fast.** It is written in Go. Can run commands in parallel.
|
|
14
14
|
* **Powerful.** It allows to control execution and files you pass to your commands.
|
|
@@ -39,18 +39,31 @@ With **Ruby**:
|
|
|
39
39
|
gem install lefthook
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
**[Installation guide](./docs/install.md)** with more
|
|
42
|
+
**[Installation guide](./docs/install.md)** with more ways to install lefthook: [apt](./docs/install.md#deb), [brew](./docs/install.md#homebrew), [winget](./docs/install.md#winget), and others.
|
|
43
43
|
|
|
44
44
|
## Usage
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
Configure your hooks, install them once and forget about it: rely on the magic underneath.
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
#### TL;DR
|
|
49
49
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
50
|
+
```bash
|
|
51
|
+
# Configure your hooks
|
|
52
|
+
vim lefthook.yml
|
|
53
|
+
|
|
54
|
+
# Install them to the git project
|
|
55
|
+
lefthook install
|
|
56
|
+
|
|
57
|
+
# Enjoy your work with git
|
|
58
|
+
git add -A && git commit -m '...'
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### More details
|
|
62
|
+
|
|
63
|
+
- [**Configuration**](./docs/configuration.md) for `lefthook.yml` config options.
|
|
64
|
+
- [**Usage**](./docs/usage.md) for **lefthook** CLI options, supported ENVs, and usage tips.
|
|
65
|
+
- [**Wiki**](https://github.com/evilmartians/lefthook/wiki) for guides, examples, and benchmarks.
|
|
66
|
+
- [**Discussions**](https://github.com/evilmartians/lefthook/discussions) for questions, ideas, suggestions.
|
|
54
67
|
|
|
55
68
|
***
|
|
56
69
|
|