angular-star-rating - npm Package Compare versions

Comparing version 2.0.0-rc.4 to 2.0.0-rc.5

package.json

 {
   "name": "angular-star-rating",
   "description": "Angular Star Rating is a Angular2 component written in typescript.",
-  "version": "2.0.0-rc.4",
+  "version": "2.0.0-rc.5",
   "scripts": {
@@ -6,0 +6,0 @@ "build": "ngc -p tsconfig.json",

README.MD

@@ -71,14 +71,26 @@ # Angular Star Rating ⭐⭐⭐⭐⭐
  - via **[npm](https://www.npmjs.org/)**: by running `$ npm install angular-star-rating --save` from your console
- - via **[bower](https://bower.io/)**: by running `$ bower install angular2-star-rating --save` from your console
-
+ 
 ## Consuming the library
 
-Once you have published your library to npm, you can import your library in any Angular application by running:
+As a precondition we consider you have your ```.angular-cli.json``` setup with an assets folder so that the ```./src/assets``` folder is included in the bundled version. 
+But this is given by default if you use the angular-cli to setup your project.
 
+Now you can import your library in your angular application by running:
+
 ```bash
-$ npm install angular-star-rating
+$ npm install angular-star-rating --save
 ```
 
-and then from your Angular `AppModule`:
+or 
 
+```bash
+$ npm install angular-star-rating@2.0.0-rc.5 --save
+```
+
+for a specific version.
+
+Create an ```assets``` folder under your ```./src``` folder and copy the images from your ```./node_modules/assets/images``` folder into ```./src/assets/images```.
+
+In your ```app.module.ts``` import the ```StarRatingModule``` to your Angular `AppModule`:
+
 ```typescript
@@ -88,7 +100,8 @@ import { BrowserModule } from '@angular/platform-browser';
 
-import { AppComponent } from './app.component';
+import { AppComponent } from './app.component';  
+  
 
-// Import your library
+// IMPORT YOUR LIBRARY
 import { StarRatingModule } from 'angular-star-rating';
-
+  
 @NgModule({
@@ -100,4 +113,4 @@ declarations: [
     BrowserModule,
-
-    // Specify your library as an import
+  
+    // SPECIFY YOUR LIBRARY AS AN  IMPORT
     StarRatingModule
@@ -111,3 +124,3 @@ ],
 
-Once your library is imported, you can use its components, directives and pipes in your Angular application:
+Once your library is imported, you can use the components in your Angular application:
 
@@ -119,8 +132,11 @@ ```html
 </h1>
-<star-rating-comp></star-rating-comp>
+  
+<!-- USE COMPONENT HERE-->
+<star-rating-comp [rating]="2.63"></star-rating-comp>
 ```
 
-If you want to ust the svg style be shure to copy the image to your assets/images folder.
+If something is not working check if 
+- the component renders the expected html
+- if you use the svg version check if the ```star-rating.icons.svg``` is present in your ```./src/assets/images``` and loaded 
 
-
 ## Component Properties
@@ -127,0 +143,0 @@

No alert changes

Improved metrics

Total package byte prevSize

153281

increased by0.37%

Number of lines in readme file

339

increased by4.95%

No dependency changes