Merge branch 'master' of https://github.com/ui-ninja/react-native-rating-element

Author: Rishabh

README.md

@@ -33,56 +33,42 @@ import { Rating } from "react-native-rating-element";
   ratingColor="#f1c644"
   ratingBackgroundColor="#d4d4d4"
   size={24}
-  readonly
+  readonly // by default is false
   icon="ios-star"
-  direction="row"
+  direction="row" // anyOf["row" (default), "row-reverse", "column", "column-reverse"]
 />
 
-**Custom Image**
+**Custom Image, onIconTap and bottom to top direction**
 <Rating
   rated={3.7}
   totalCount={5}
   size={42}
   onIconTap={position => console.log(`User pressed: ${position}`)}
-  direction="row"
-  type="custom"
+  direction="column-reverse"
+  type="custom" // default is always to "icon"
   selectedIconImage={require('./filled.png')}
   emptyIconImage={require('./empty.png')}
 />
 
-**If you want to record user tap on star icon**
-
-<Rating
-  rated={3.7}
-  totalCount={5}
-  ratingColor="#f1c644"
-  ratingBackgroundColor="#d4d4d4"
-  size={24}
-  onIconTap={position => console.log(`User pressed: ${position}`)}
-  icon="ios-star"
-  direction="row"
-/>
-
-
 ```
 
 ## API
 
 | prop                      | default    | type              | description                                                                                                                                                                                                                                  |
 | ------------------------- | ---------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `type`                    | `icon`     | string            | Be default the value is set to "icon" type. If you want custom images, then pass `custom` as prop value. <br />In case of `custom`, Make sure to pass `selectedIconImage` and `emptyIconImage`.                                              |  |
 | `rated`                   | 0          | number            | Represents Initial value for the rating.                                                                                                                                                                                                     |
 | `totalCount`              | 5          | number            | Number of background stars to show. For ex. Rated 5 out of 10 stars. The 10 value is `totalCount`                                                                                                                                            |
+| `type`                    | `icon`     | string            | If you want custom images, then pass `custom` as prop value. <br />In case of `custom`, Make sure to pass `selectedIconImage` and `emptyIconImage`.                                                                                          |
+| `selectedIconImage`       | -          | image path (node) | Pass in custom path for selected icon. For ex. `selectedIconImage={require('../pathToImage/image.png}`.                                                                                                                                      |
+| `emptyIconImage`          | -          | image path (node) | Pass in custom path for selected icon. For ex. `emptyIconImage={require('../pathToImage/image.png}`.                                                                                                                                         |
+| `readonly`                | false      | bool              | If passed true, onPress event won't be fired.                                                                                                                                                                                                |
+| `direction`               | 'row'      | string            | Pass any value from `[ "row", "row-reverse", "column", "column-reverse"]`.                                                                                                                                                                   |  |
+| `onIconTap`               | -          | func              | On press of star icon by user, this function will be invoked with `position` paramter. For ex. when user taps on 4 rating, this function will be invoked and in `position` parameter you will get value 4.                                   |
 | `ratingColor`             | #f1c644    | string (color)    | Pass in a custom color to fill-color the rating icon.                                                                                                                                                                                        |
 | `ratingBackgroundColor`   | #d4d4d4    | string (color)    | Pass in a custom fill-color for the background of rating icon. It is sometimes referred as empty icon.                                                                                                                                       |
 | `size`                    | 24         | number            | Pass in a custom font size for the icon                                                                                                                                                                                                      |
 | `icon`                    | 'ios-star' | string            | Pass in a custom text for the icon. For ex. 'beer', 'bulb'. These icons are imported from package [react-native-vector-icons](https://oblador.github.io/react-native-vector-icons/). Please Note: For now this package only support Ionicons |
 | `marginBetweenRatingIcon` | 1          | number            | Pass in custom number to manage space or margin between the rating icons.                                                                                                                                                                    |
-| `onIconTap`               | -          | func              | On press of star icon by user, this function will be invoked with `position` paramter. For ex. when user taps on 4 rating, this function will be invoked and in `position` parameter you will get value 4.                                   |
-| `readonly`                | false      | bool              | If passed true, onPress event won't be fired.                                                                                                                                                                                                |
-| `direction`               | 'row'      | string            | Pass any value from `[ "row", "row-reverse", "column", "column-reverse"]`.                                                                                                                                                                   |
-| `selectedIconImage`       | -          | image path (node) | Pass in custom path for selected icon. For ex. `selectedIconImage={require('../pathToImage/image.png}`.                                                                                                                                      |
-| `emptyIconImage`          | -          | image path (node) | Pass in custom path for selected icon. For ex. `emptyIconImage={require('../pathToImage/image.png}`.                                                                                                                                         |
 
 ## Output