updated readme

ptariche · Sep 26, 2017 · 7aec393 · 7aec393
1 parent c67268a
commit 7aec393
Showing 1 changed file with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,25 @@
 # Lookup a Vehicle in the United States
 A Simple Node Module to Lookup a vehicle via a VIN number with the nhtsa.dot.gov API
 
+[![npm version](https://img.shields.io/npm/v/lookup_vehicle.svg?style=flat-square)](https://www.npmjs.org/package/lookup_vehicle)
+
+### Install
+
+```
+Using npm:
+
+$ npm install lookup_vehicle
+```
+
 **functions**
 
-- ***.lookup({String}, {AxiosConfig}) @return {promise}***
-- ***.lookup_callback({String}, {Callback}) callback***
+- ***.lookup({String}, {AxiosConfig}) @return {promise}*** *async function*
+- ***.lookup_callback({String}, {Callback}) callback*** *function*
+
+
+```js
+let LookupVehicle = require('lookup_vehicle');
+```
 
 #### Traditional Promise Method