Skip to content

Commit 44af9fc

Browse files
committed
better introduce in readme:)
1 parent a94441d commit 44af9fc

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
11
# pre-commit-shell
22
![Branch master](https://img.shields.io/badge/branch-master-brightgreen.svg?style=flat-square)[![Build](https://api.travis-ci.org/detailyang/pre-commit-shell.svg)](https://travis-ci.org/detailyang/pre-commit-shell)[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/detailyang/pre-commit-shell/master/LICENSE)[![release](https://img.shields.io/github/release/detailyang/pre-commit-shell.svg)](https://github.com/detailyang/pre-commit-shell/releases)
3+
34
pre commit wrapper shellcheck
5+
pre-commit-shell is a [pre-commit](https://github.com/pre-commit/pre-commit) commponent, which wrapper [shellcheck](https://www.shellcheck.net/) to check shell scripts:)
6+
7+
Table of Contents
8+
-----------------
9+
10+
* [Requirements](#requirements)
11+
* [Install](#install)
12+
* [Contributing](#contributing)
13+
* [License](#license)
14+
* [Author](#author)
15+
16+
Requirements
17+
------------
18+
pre-commit-shell requires the following to run:
19+
20+
* [pre-commit](pre-commit.com)
21+
* [shellcheck](https://www.shellcheck.net/)
22+
23+
24+
Install
25+
---------
26+
27+
1. create .pre-commit-config.yaml in you git project
28+
2. pre-commit install
29+
3. enjoy it
30+
31+
example .pre-commit-config.yaml as following:
32+
33+
```yaml
34+
- repo: git://github.com/detailyang/pre-commit-shell
35+
sha: 1.0.0
36+
hooks:
37+
- id: shell-lint
38+
```
39+
Contributing
40+
------------
41+
42+
To contribute to pre-commit-shell, clone this repo locally and commit your code on a separate branch.
43+
44+
45+
Author
46+
------
47+
48+
> GitHub [@detailyang](https://github.com/detailyang)
49+
50+
51+
License
52+
-------
53+
54+
pre-commit-shell is licensed under the [MIT] license.

0 commit comments

Comments
 (0)