Skip to content

Commit 7a0f251

Browse files
committedFeb 6, 2019
Added README
1 parent f845ea7 commit 7a0f251

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed
 

‎README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# middleware-https
2+
3+
Simple force HTTPS redirect middleware, meant for use behind a proxy (e.g. Heroku).
4+
5+
## Installation
6+
7+
```sh
8+
npm i @includable/middleware-https
9+
```
10+
11+
## Usage
12+
13+
```js
14+
const express = require('express')
15+
const https = require('@includable/middleware-https')
16+
17+
app.use(https('example.com')) // leave out parameter to apply to all domains
18+
19+
app.listen(process.env.PORT || 3000, () => console.log(`Example app running.`))
20+
```

0 commit comments

Comments
 (0)
Please sign in to comment.