Skip to content

Commit 36bb210

Browse files
author
Hans Kristian Flaatten
committed
docs(project): document project to README.md
1 parent cbb73ff commit 36bb210

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

Diff for: README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# @turbasen/auth
2+
3+
[![Build status](https://app.wercker.com/status/2a2f71ebdf1919fd1a97773e7c606707/s "wercker status")](https://app.wercker.com/project/bykey/2a2f71ebdf1919fd1a97773e7c606707)
4+
[![Codacy grade](https://img.shields.io/codacy/grade/80888af28075493d854c1103338218ac.svg "Codacy grade")](https://www.codacy.com/app/Turbasen/Auth)
5+
[![Codacy coverage](https://img.shields.io/codacy/coverage/80888af28075493d854c1103338218ac.svg "Codacy coverage")](https://www.codacy.com/app/Turbasen/Auth)
6+
[![NPM downloads](https://img.shields.io/npm/dm/@turbasen/auth.svg "NPM downloads")](https://www.npmjs.com/package/@turbasen/auth)
7+
[![NPM version](https://img.shields.io/npm/v/@turbasen/auth.svg "NPM version")](https://www.npmjs.com/package/@turbasen/auth)
8+
[![Node version](https://img.shields.io/node/v/@turbasen/auth.svg "Node version")](https://www.npmjs.com/package/@turbasen/auth)
9+
[![Dependency status](https://img.shields.io/david/Turbasen/Auth.svg "Dependency status")](https://david-dm.org/Turbasen/Auth)
10+
11+
Authentication middleware used internally at Nasjonal Turbase API.
12+
13+
## Getting started
14+
15+
Download [Docker for Mac or Windows](https://www.docker.com/products/docker).
16+
17+
Run in this directory:
18+
19+
```
20+
$ docker-compose up
21+
```
22+
23+
Docker is now watching for changes and will run the test suite automatically.
24+
25+
## [MIT lisenced](https://github.com/Turbasen/Auth/blob/master/LICENSE)

0 commit comments

Comments
 (0)