Skip to content

Commit cf99cd2

Browse files
committed
Update LICENSE and Readme
1 parent eface46 commit cf99cd2

2 files changed

Lines changed: 13 additions & 15 deletions

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015 Arnout Kazemier, Martijn Swaagman, the Contributors.
3+
Copyright (c) 2021 Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
# pre-commit
1+
# @fastify/pre-commit
22

3-
[![Version npm][version]](http://browsenpm.org/package/pre-commit)[![Build Status][build]](https://travis-ci.org/observing/pre-commit)[![Dependencies][david]](https://david-dm.org/observing/pre-commit)[![Coverage Status][cover]](https://coveralls.io/r/observing/pre-commit?branch=master)
4-
5-
[version]: http://img.shields.io/npm/v/pre-commit.svg?style=flat-square
6-
[build]: http://img.shields.io/travis/observing/pre-commit/master.svg?style=flat-square
7-
[david]: https://img.shields.io/david/observing/pre-commit.svg?style=flat-square
8-
[cover]: http://img.shields.io/coveralls/observing/pre-commit/master.svg?style=flat-square
9-
10-
**pre-commit** is a pre-commit hook installer for `git`. It will ensure that
3+
**@fastify/pre-commit** is a pre-commit hook installer for `git`. It will ensure that
114
your `npm test` (or other specified scripts) passes before you can commit your
125
changes. This all conveniently configured in your `package.json`.
136

@@ -16,12 +9,12 @@ But don't worry, you can still force a commit by telling `git` to skip the
169

1710
### Installation
1811

19-
It's advised to install the **pre-commit** module as a `devDependencies` in your
12+
It's advised to install the **@fastify/pre-commit** module as a `devDependencies` in your
2013
`package.json` as you only need this for development purposes. To install the
2114
module simply run:
2215

2316
```
24-
npm install --save-dev pre-commit
17+
npm install --save-dev @fastify/pre-commit
2518
```
2619

2720
To install it as `devDependency`. When this module is installed it will override
@@ -30,11 +23,11 @@ the existing `pre-commit` file in your `.git/hooks` folder. Existing
3023

3124
### Configuration
3225

33-
`pre-commit` will try to run your `npm test` command in the root of the git
26+
`@fastify/pre-commit` will try to run your `npm test` command in the root of the git
3427
repository by default unless it's the default value that is set by the `npm
3528
init` script.
3629

37-
But `pre-commit` is not limited to just running your `npm test`'s during the
30+
But `@fastify/pre-commit` is not limited to just running your `npm test`'s during the
3831
commit hook. It's also capable of running every other script that you've
3932
specified in your `package.json` "scripts" field. So before people commit you
4033
could ensure that:
@@ -127,7 +120,7 @@ Configuration can also be defined inside a standalone `.pre-commit.json` config
127120
}
128121
```
129122

130-
The contents of `.pre-commit.json` will be used in the place of whatever was defined in the `pre-commit`
123+
The contents of `.pre-commit.json` will be used in the place of whatever was defined in the `pre-commit`
131124
or `precommit` property inside `package.json`.
132125

133126
It's all the same. Different styles so use what matches your project. To learn
@@ -142,3 +135,8 @@ http://githooks.com
142135
### License
143136

144137
MIT
138+
139+
### Attribution
140+
141+
The `@fastify/pre-commit` package is a fork of the original work found at
142+
https://github.com/observing/pre-commit.

0 commit comments

Comments
 (0)