ng-star - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

package.json

 {
   "name": "ng-star",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "peerDependencies": {
@@ -5,0 +5,0 @@ "@angular/common": "^9.1.13",

README.md

@@ -1,8 +0,148 @@
-This Angular library generates stars (in yellow color) for rating provided in range of 0.0 to 5.0.
+# NgStar
 
-To use this library:
+## This Angular library generates stars (in yellow color) for rating provided in range of 0.0 to 5.0.
+
+## To use this library:
 1) Npm install ng-star
-2) In angular component wherever you want to use it, import this component and then,
+2) In angular component wherever you want to use it, import this component and 		then
    `<lib-ng-star [rating]="2.5"></lib-ng-star>`
    2.5 stars with yellow color and remaining 2.5 stars with white color will be generated
-   
+
+## Published On NPM 'https://www.npmjs.com/package/ng-star'
+
+
+This Angular library generates stars (in yellow color) for rating provided in range of 0.0 to 5.0
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/sami-colon/ng-star">
+    <img src="images/image1.png" alt="sample image" width="1000" height="500">
+  </a>
+
+<h3 align="center">Ng Star</h3>
+
+  <p align="center">
+    This Angular library generates stars (in yellow color) for rating provided in range of 0.0 to 5.0
+    <br />
+    <a href="https://github.com/sami-colon/ng-star"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/sami-colon/ng-star/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/sami-colon/ng-star/issues">Request Feature</a>
+  </p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+[ng-star](https://www.npmjs.com/package/ng-star)
+<p>
+	This Angular library generates stars (in yellow color) for rating provided in range of 0.0 to 5.0
+</p>
+
+
+### Built With
+
+* [Angular 9]()
+* [Css](https://developer.mozilla.org/en-US/docs/Learn/CSS)
+* [Bootstrap 4](https://getbootstrap.com/docs/4.0/getting-started/introduction/)
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these simple steps.
+
+### Prerequisites
+none
+
+### Installation
+
+1. install package from npmjs
+   ```sh
+   npm install ng-star
+   ```
+
+
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+For the stars to generate correctly, **make sure ng-star component is wrapped with atleast 200px width and 75px height**:
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Abhishek Kumar - [Email](mailto:[e-mail])
+
+Project Link: [https://github.com/sami-colon/ng-star](https://github.com/sami-colon/ng-star)
+
+
+
+## sample images
+<img src="images/image1.png" alt="Logo">
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/sami-colon/repo.svg?style=for-the-badge
+[contributors-url]: https://github.com/sami-colon/eLearn-template/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/sami-colon/repo.svg?style=for-the-badge
+[forks-url]: https://github.com/sami-colon/eLearn-template/network/members
+[stars-shield]: https://img.shields.io/github/stars/sami-colon/repo.svg?style=for-the-badge
+[stars-url]: https://github.com/sami-colon/eLearn-template/stargazers
+[issues-shield]: https://img.shields.io/github/issues/sami-colon/repo.svg?style=for-the-badge
+[issues-url]: https://github.com/sami-colon/eLearn-template/issues
+[license-shield]: https://img.shields.io/github/license/sami-colon/repo.svg?style=for-the-badge
+[license-url]: https://github.com/sami-colon/eLearn-template/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/sami-colon
+

No alert changes

Improved metrics

Total package byte prevSize

107745

increased by8.72%

Number of package files

24

increased by4.35%

Number of lines in readme file

149

increased by1555.56%

No dependency changes