Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
Added content to the README to make it follow NPM style more closely
  • Loading branch information
aszecsei committed Nov 11, 2017
1 parent e715256 commit b51e2c5
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# TypeScript library starter

> A TypeScript library to handle vector and matrix math.
[![NPM Version](https://img.shields.io/npm/v/ts-vector-math.svg)](https://npmjs.org/package/ts-vector-math)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Greenkeeper badge](https://badges.greenkeeper.io/aszecsei/ts-vector-math.svg)](https://greenkeeper.io/)
[![Travis](https://img.shields.io/travis/aszecsei/ts-vector-math.svg)](https://travis-ci.org/aszecsei/ts-vector-math)
[![Coveralls](https://img.shields.io/coveralls/aszecsei/ts-vector-math.svg)](https://coveralls.io/github/aszecsei/ts-vector-math)

A TypeScript library to handle vector and matrix math.

### Usage
## Install

```bash
npm install ts-vector-math --save-dev
```
## License
[MIT](http://vjpr.mit-license.org)

0 comments on commit b51e2c5

Please sign in to comment.