From cf030719fc5a99cc0bbce147bf41a29c49c70ede Mon Sep 17 00:00:00 2001
From: Majd Sabah <msabah@winfooz.com>
Date: Mon, 8 Oct 2018 12:12:29 +0300
Subject: [PATCH] update readme

---
 README.me | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.me b/README.me
index e7e8876..ae59ad0 100644
--- a/README.me
+++ b/README.me
@@ -1 +1,39 @@
-Read me
\ No newline at end of file
+# 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)
\ No newline at end of file