Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Majd Sabah committed Oct 8, 2018
1 parent 6404946 commit cf03071
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.me
Original file line number Diff line number Diff line change
@@ -1 +1,39 @@
Read me
# SwiftyVIN 1.0

A Swift version of VIN validations using Swift 4.2

## Getting Started

```
import SwiftyVIN
```

```
let swiftyVin: SwiftyVIN = SwiftyVIN("")
```

Then

```
swiftyVin.isValid()
```

### Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

```
Give the example
```

## Running the tests

Checking valid and invalid VIN with 100% code coverage.


## Reference

* [VIN.pdf](http://assets.ibc.ca/Documents/Auto%20Insurance/brochure/Understanding-Vehicle-Identification-Numbers.pdf) - VIN document.
* inspired from [python-libvin](https://github.com/h3/python-libvin)

0 comments on commit cf03071

Please sign in to comment.