Merge pull request #1 from devamaz/master

add doc

.travis.yml

@@ -0,0 +1,25 @@
+language: node_js
+
+node_js:
+  - node
+  - 11.0.0
+  - 12.0.0
+  - 13.0.0
+  - 14.0.0
+  - 15.0.0
+  - 16.0.0
+
+sudo: false
+
+
+install:
+  - npm install
+
+cache:
+  directories:
+    - ~/.npm # cache npm's cache
+    - ~/npm # cache latest npm
+
+notifications:
+  email:
+    - [email protected]

readme.md

@@ -1 +1,38 @@
-# Convert Nigeria Phone Numbers
+# Convert Nigeria Phone Numbers
+
+[![NPM Version][npm-image]][npm-url]
+
+add +234 to any nigeria number
+
+### Overview
+This project help handle the problem of user registering with +23480xxxxxx and trying to login with 80xxxxx
+
+### Installation
+npm
+```
+npm i --save convertngnum
+```
+yarn
+```
+yarn add convertngnum
+```
+
+### Usage
+```js
+// Require the library
+const convertngnum = require("convertngnum");
+
+let convertNum = convertngnum('08078xxxxxx')
+
+```
+
+### License
+MIT
+
+### Credits
+- [Ahmad Abdulaziz](https://twitter.com/devamaz)
+- [Hassan Sani](https://twitter.com/inidaname)
+
+
+[npm-image]: https://img.shields.io/npm/v/convertngnum?color=red
+[npm-url]: https://www.npmjs.com/package/convertngnum