Skip to content

Commit

Permalink
docs: update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
LuisUrrutia committed Apr 17, 2018
1 parent 0d3fc88 commit fb160b1
Showing 1 changed file with 43 additions and 4 deletions.
47 changes: 43 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Text Mask RUT
> A Text Mask addon to format the Chilean National Identifier Number (RUT)

[![Node version](https://img.shields.io/node/v/text-mask-rut.svg?style=flat)](http://nodejs.org/download/)
[![NSP Status](https://nodesecurity.io/orgs/luisurrutia/projects/f3a88dff-5825-471b-87fc-07a2b513c1ac/badge)](https://nodesecurity.io/orgs/luisurrutia/projects/f3a88dff-5825-471b-87fc-07a2b513c1ac)

A Text Mask addon to format the Chilean National Identifier Number (RUT)

One to two paragraph statement about your product and what it does.

![Demo](rut.gif)

Expand All @@ -14,12 +16,48 @@ yarn add text-mask-rut

## Usage example

React Example
```javascript
import React from 'react'
import MaskedInput from 'react-text-mask'
import createRutMask from 'text-mask-rut';

export default () => (
<div>
<MaskedInput
mask={createRutMask}
/>
</div>
)
```

Vanilla JS Example
```javascript
var myInput = document.querySelector('.maskedInput');

vanillaTextMask.maskInput({
inputElement: myInput,
mask: createRutMask(),
});
```

## Development setup
There isn't additional steps to:
```sh
yarn install
```

But always check the tests and lint before to commit or PR

## Release History

* 0.0.2
* Fix UMD build
* Reformat main code
* Add integrations with travis, coveralls, codeclimate and NodeSecurity
* Add example
* Improve README

* 0.0.1
* Work in progress

Expand All @@ -33,5 +71,6 @@ Distributed under the MIT license. See ``LICENSE`` for more information.
1. Fork it (<https://github.com/LuisUrrutia/text-mask-rut/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
4. Check the tests and lint (`yarn lint && yarn test`)
5. Push to the branch (`git push origin feature/fooBar`)
6. Create a new Pull Request

0 comments on commit fb160b1

Please sign in to comment.