add documentation

inidaname · May 21, 2021 · f10b4a0 · f10b4a0
1 parent aeb0542
commit f10b4a0
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 2 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -8,10 +8,10 @@ node_js:
   - 14.0.0
   - 15.0.0
   - 16.0.0
-  - 17.0.0
 
 sudo: false
 
+
 install:
   - npm install
 

diff --git a/readme.md b/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
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,10 +8,10 @@ node_js: @@
       - 14.0.0
       - 15.0.0
       - 16.0.0
-      - 17.0.0
     sudo: false
     install:
       - npm install
@@ Expand Down @@