rn-broadcast-view-tmp - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "rn-broadcast-view-tmp",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "author": "[e-mail]",
@@ -5,0 +5,0 @@ "description": "A native widget which looks like a broadcast station. Circle of 'broadcast waves' appear when 'broadcasting' property is set to true.",

README.md

@@ -1,2 +0,40 @@
-# RNBroadcastView
-A native widget which looks like a broadcast station. Circle of 'broadcast waves' appear when 'broadcasting' property is set to true
+# BroadcastView
+A high quality react native component backed by custom native iOS and Android views.
+
+<center>
+![Demo](/demo_android.gif)
+</center>
+
+## Installation
+1. Add
+
+   * npm: `npm install --save rn-broadcast-view`
+   * yarn: `yarn add rn-broadcast-view`
+
+2. Link
+   - Run `react-native link  rn-broadcast-view`
+   - If linking fails, follow the
+     [manual linking steps](https://facebook.github.io/react-native/docs/linking-libraries-ios.html#manual-linking)
+
+
+## Usage
+
+```BroadcastView``` should have fixed width and height.
+
+```
+import BroadcastView from 'rn-broadcast-view';
+
+...
+
+<BroadcastView style={{width: 100, height: 100}} />
+
+...
+```
+
+#### Properties
+
+| Property |      Description      | Type | Default Value |
+|----------|-----------------------|------|:-------------:|
+| broadcasting | An infinite "broadcast wave" animation is shown if true | Boolean | **false** |
+| stationColor |  Color of station | String<br/>(**#RRGGBB** or **#AARRGGBB**) | **#4286f4** |
+| waveColor |  Color of waves | String<br/>(**#RRGGBB** or **#AARRGGBB**) | **#ff60ad** |

No alert changes

Improved metrics

Total package byte prevSize

2512187

increased by125.89%

Number of package files

193

increased by0.52%

Number of lines in readme file

40

increased by1233.33%

No dependency changes