Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Commit

Permalink
Shortened readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stigok committed Oct 26, 2015
1 parent 42baf92 commit 4bdba4f
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.md
Expand Up @@ -9,24 +9,21 @@ Install with npm (https://www.npmjs.com/package/http2s)

npm install http2s

or clone repo and take care of dependencies yourself
## Quick start

git clone https://github.com/stigok/http2s.git && cd http2s
npm install
Redirect clients from *http:8080* to *https:8443*

## Usage

http2s([options,] [callback])
// callback is a function called with *callback(err, settings)* on done
npm run development

Two example scripts are available
Redirect clients from *http:80* to *https:443*

// Automatic redirect from http:80 to https:443
// Needs special privileges for all ports < 1000 (or root access, but not advised)
npm run production

// Manual redirect from http:8080 to https:8443
npm run development
## Usage

http2s([options,] [callback])

Calls `callback(err, activeSettings)` on done

## Options

Expand Down Expand Up @@ -78,13 +75,6 @@ With options
)
})

## Run tests

*Warning:* weak coverage

npm install --dev
npm test

## Disclaimer

Use at own risk.
Expand Down

0 comments on commit 4bdba4f

Please sign in to comment.