Skip to content

Commit

Permalink
🙂 Add emojis to README
Browse files Browse the repository at this point in the history
  • Loading branch information
screendriver committed Nov 5, 2018
1 parent dfff9b3 commit 1025a0e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@

Verifies the [secret](https://developer.github.com/v3/repos/hooks/#create-hook-config-params) that is sent in [GitHub Webhooks](https://developer.github.com/webhooks/). The `secret` will be used as the key to generate the HMAC hex digest value in the `X-Hub-Signature` header.

## Installation
## Installation 🏗

```sh
$ yarn install verify-github-webhook-secret
$ npm install --save verify-github-webhook-secret
```

or with npm
or if you use [Yarn](https://yarnpkg.com) 🐈

```sh
$ npm install --save verify-github-webhook-secret
$ yarn add verify-github-webhook-secret
```

## Usage
## Usage 🔨

The exported function needs a [http.IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage) and your personal `secret` string. It returns a Promise that fulfills with a boolean if the received secret is valid or not.

Expand Down

0 comments on commit 1025a0e

Please sign in to comment.