description updated

aeyrium · Oct 1, 2018 · 137cbb7 · 137cbb7
1 parent 3591561
commit 137cbb7
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 10 deletions.
diff --git a/.packages b/.packages
@@ -1,4 +1,4 @@
-# Generated by pub on 2018-09-28 12:00:15.862974.
+# Generated by pub on 2018-10-01 00:27:14.674097.
 analyzer:file:///Users/diegoveloper/Development/SDKS/flutter/.pub-cache/hosted/pub.dartlang.org/analyzer-0.32.4/lib/
 args:file:///Users/diegoveloper/Development/SDKS/flutter/.pub-cache/hosted/pub.dartlang.org/args-1.5.0/lib/
 async:file:///Users/diegoveloper/Development/SDKS/flutter/.pub-cache/hosted/pub.dartlang.org/async-2.0.8/lib/

diff --git a/README.md b/README.md
@@ -1,10 +1,42 @@
-# Aeyrium Sensor
 
-Flutter plugin for get the Pitch and Roll on Android and iOS. It's using TYPE_ROTATION_VECTOR sensor on Android and DeviceMotion on iOS.
+# Flutter Aeyrium Sensor Plugin 
 
-## Getting Started
+[Aeyrium Sensor Plugin](https://pub.dartlang.org/packages/aeyrium_sensor)
 
-For help getting started with Flutter, view our online
-[documentation](https://flutter.io/).
+A Flutter sensor plugin which provide easy access to the Pitch and Roll on Android and iOS devices. It was made using TYPE_ROTATION_VECTOR sensor on Android and DeviceMotion on iOS.
 
-For help on editing plugin code, view the [documentation](https://flutter.io/developing-packages/#edit-plugin-package).
+## Usage
+
+To use this plugin, add `aeyrium_sensor` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). For example:
+
+```yaml
+dependencies:
+  aeyrium_sensor: ^1.0.0
+```
+
+## Usage
+
+``` dart
+import 'package:aeyrium_sensor/aeyrium_sensor.dart';
+
+AeyriumSensor().sensorEvents.listen((SensorEvent event) {
+      //do something with the event
+      print("Pitch ${event.pitch} and Roll ${event.roll}")
+
+    });
+
+```
+
+## Real Demo
+
+We developed this plugin to use it on our Attitude indicator screen.
+[![Aeyrium Sensor](http://img.youtube.com/vi/IIoa9uNka_0/0.jpg)](http://www.youtube.com/watch?v=IIoa9uNka_0 "Attitude indicator")
+
+
+## Issues
+
+Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/aeyrium/aeyrium-sensor/issues) page.
+
+## Author
+
+This Aeyrium Sensor plugin for Flutter is developed by [Aeyrium Inc](https://aeyrium.com)
diff --git a/android/src/main/java/com/aeyrium/sensor/AeyriumSensorPlugin.java b/android/src/main/java/com/aeyrium/sensor/AeyriumSensorPlugin.java
@@ -71,7 +71,7 @@ public void onSensorChanged(SensorEvent event) {
       }
     };
   }
-
+  
   private void updateOrientation(float[] rotationVector, EventChannel.EventSink events) {
     float[] rotationMatrix = new float[9];
     SensorManager.getRotationMatrixFromVector(rotationMatrix, rotationVector);
@@ -118,4 +118,4 @@ private void updateOrientation(float[] rotationVector, EventChannel.EventSink ev
     sensorValues[1] = roll;
     events.success(sensorValues);
   }
-}
+}
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: aeyrium_sensor
-description: Flutter plugin for get the Pitch and Roll on Android and iOS. It's using TYPE_ROTATION_VECTOR sensor on Android and DeviceMotion on iOS.
+description: A Flutter sensor plugin which provide easy access to the Pitch and Roll on Android and iOS devices. It was made using TYPE_ROTATION_VECTOR sensor on Android and DeviceMotion on iOS.
 version: 1.0.0
 author: Diego Velásquez <diego@aeyrium.com>
 homepage: https://github.com/aeyrium/aeyrium-sensor/