feat(star-ratings): StarRatings v2

Author: triniwiz

docs/src/api-reference/star-ratings.md

@@ -1,12 +1,77 @@
 # Star-Ratings
 
+[![npm](https://img.shields.io/npm/v/@triniwiz/nativescript-star-ratings.svg)](https://www.npmjs.com/package/@triniwiz/nativescript-star-ratings)
+[![npm](https://img.shields.io/npm/dt/@triniwiz/nativescript-star-ratings.svg?label=npm%20downloads)](https://www.npmjs.com/package/@triniwiz/nativescript-star-ratings)
+
 |   Android Device  |   Android Emulator    |   iOS Device  |   iOS Simulator   |
 | :-------------:     |:-------------:        |:-------------:| :-----:            |
-| :white_check_mark:|:white_check_mark:     |:white_check_mark:|    :negative_squared_cross_mark:| 
+| :white_check_mark:|:white_check_mark:     |:white_check_mark:|    :white_check_mark:| 
 
 
 ## Installing 
 
 ```base
     ns plugin add @triniwiz/nativescript-star-ratings
-```
+```
+
+# Configuration
+
+### Core
+
+::: tip IMPORTANT
+Ensure you've included `xmlns:ui="@triniwiz/nativescript-star-ratings"` on the
+Page element
+:::
+
+```xml
+<ui:StarRating emptyBorderColor="white" emptyColor="white" filledBorderColor="black" filledColor="red" value="2" max="5"/>
+```
+
+### Angular
+
+```ts
+import { registerElement } from '@nativescript/angular/element-registry';
+registerElement('StarRating', () => require('@triniwiz/nativescript-star-ratings').StarRating);
+```
+
+### Vue
+
+```ts
+import { registerElement } from "nativescript-vue'";
+registerElement('StarRating', () => require('@triniwiz/nativescript-star-ratings').StarRating);
+```
+
+
+
+### React
+
+```ts
+import { registerElement } from "react-nativescript";
+registerElement('StarRating', () => require('@triniwiz/nativescript-star-ratings').StarRating);
+```
+
+
+
+### Svelte
+
+```ts
+import { registerNativeViewElement } from 'svelte-native/dom';
+registerNativeViewElement('StarRating', () => require('@triniwiz/nativescript-star-ratings').StarRating);
+```
+
+```html
+<StarRating emptyBorderColor="white" emptyColor="white" filledBorderColor="black" filledColor="red" value="{{value}}" max="{{max}}" isindicator="false"></StarRating>
+```
+
+
+## API
+
+|   Property  |   Default    |   Type  |   iOS  | Android |
+| :-------------:|:-------------: |:-------------:| :-----:| :-----:|
+| emptyBorderColor |blue    | string | :white_check_mark: | :x: |
+| emptyColor |white    | string | :white_check_mark: | :white_check_mark: |
+| filledBorderColor |blue    | string | :white_check_mark: | :x: |
+| filledColor |white    | string | :white_check_mark: | :white_check_mark: |
+| value |0    | number | :white_check_mark: | :white_check_mark: |
+| max |5    | number | :white_check_mark: | :white_check_mark: |
+| isindicator |false    | false | :x: | :white_check_mark: |

packages/nativescript-star-ratings/README.md

@@ -4,9 +4,12 @@
 ns plugin add @triniwiz/nativescript-star-ratings
 ```
 
-## Usage
 
-// TODO
+## API documentation
+
+[Documentation for the latest stable release](https://triniwiz.github.io/nativescript-plugins/api-reference/star-ratings.html)
+
+
 
 ## License
 

packages/nativescript-star-ratings/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@triniwiz/nativescript-star-ratings",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"description": "NativeScript star ratings UI component plugin.",
 	"main": "index",
 	"typings": "index.d.ts",
@@ -12,7 +12,7 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/triniwiz/plugins.git"
+		"url": "https://github.com/triniwiz/nativescript-plugins.git"
 	},
 	"keywords": [
 		"NativeScript",
@@ -25,11 +25,23 @@
 		"name": "Osei Fortune",
 		"email": "[email protected]"
 	},
+	"contributors": [
+		{
+			"name": "Sean Perkins",
+			"email": "[email protected]",
+			"url": "https://github.com/sean-perkins"
+		},
+		{
+			"name": "Yeshwanth Alampalli",
+			"email": "[email protected]",
+			"url": "https://github.com/Alampalli-Yeshwanth"
+		}
+	],
 	"bugs": {
-		"url": "https://github.com/triniwiz/plugins/issues"
+		"url": "https://github.com/triniwiz/nativescript-plugins/issues"
 	},
 	"license": "Apache-2.0",
-	"homepage": "https://github.com/triniwiz/plugins",
+	"homepage": "https://github.com/triniwiz/nativescript-plugins",
 	"readmeFilename": "README.md",
 	"bootstrapper": "@nativescript/plugin-seed"
-}
+}