msg91.js - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "msg91.js",
-  "version": "1.0.2",
-  "description": "MSG91.com api sdk/wrapper",
+  "version": "1.0.3",
+  "description": "A simplified, promise based msg91.com javascript sdk",
   "main": "./dist/index.js",
@@ -24,3 +24,3 @@ "scripts": {
   ],
-  "author": "Shahid Kamal <[e-mail]> (https://shahidkamal.ml/) ",
+  "author": "Shahid Kamal <[e-mail]>",
   "license": "Apache-2.0",
@@ -27,0 +27,0 @@ "devDependencies": {

README.md

@@ -1,5 +0,57 @@
-### msg91.js is wrapper around msg91 apis.
+<h1 align="center">Welcome to msg91.js 👋</h1>
+<p>
+  <a href="https://www.npmjs.com/package/msg91.js" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/msg91.js.svg">
+  </a>
+  <a href="docs.md" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="#" target="_blank">
+    <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
+  </a>
+  <a href="https://twitter.com/shahidcodes" target="_blank">
+    <img alt="Twitter: shahidcodes" src="https://img.shields.io/twitter/follow/shahidcodes.svg?style=social" />
+  </a>
+</p>
 
-#### Docs
+> A simplified, promise based [msg91.com](https://msg91.com) javascript sdk.
 
-Docs are generated with the help of [TypeDoc](http://typedoc.org) and can be found here [Doc](http://git.shahidkamal.ml/msg91.js/)
+### 🏠 [Homepage](https://github.com/shahidcodes/msg91.js/blob/master/README.md)
+
+## Install
+
+```sh
+npm install
+```
+
+## Usage
+
+```sh
+const msg91 = require('msg91.js');
+```
+
+## Run tests
+
+```sh
+npm run test
+```
+
+## Author
+
+👤 **Shahid Kamal**
+
+- Website: http://shahidkamal.ml
+- Twitter: [@shahidcodes](https://twitter.com/shahidcodes)
+- Github: [@shahidcodes](https://github.com/shahidcodes)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/shahidcodes/msg91.js/issues).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+---
+
+_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22039

increased by6.34%

Number of lines in readme file

58

increased by866.67%

No dependency changes