Merge branch 'master' of https://github.com/joshblour/react-native-he…

…ading

* 'master' of https://github.com/joshblour/react-native-heading:
  Small thingys
  Update README.md
  Update README.md
  Update README.md

README.md

@@ -1,67 +1,52 @@
-# Discovery
-Discover nearby devices using BLE.
-
-React native implementation of https://github.com/omergul123/Discovery
-
-(Android uses https://github.com/joshblour/discovery-android)
+# React Native Heading
+Get device heading information on iOS or Android
 
 ##What
-Discovery is a very simple but useful library for discovering nearby devices with BLE(Bluetooth Low Energy) and for exchanging a value (kind of ID or username determined by you on the running app on peer device) regardless of whether the app on peer device works at foreground or background state.
-
+Report back device orientation in degrees, 0-360, with 0 being North.
 
 ####Example
 ```java
-const {DeviceEventEmitter} = require('react-native');
-const Discovery = require('react-native-discovery');
-
-Discovery.initialize(
-  "3E1180E5-222E-43E9-98B4-E6C0DD18E728",
-  "SpacemanSpiff"
-);
-Discovery.setShouldAdvertise(true);
-Discovery.setShouldDiscover(true);
-
-// Listen for discovery changes
-DeviceEventEmitter.addListener(
-  'discoveredUsers',
-  (data) => {
-    if (data.didChange || data.usersChanged) //slight callback discrepancy between the iOS and Android libraries
-      console.log(data.users)
-  }
-);
+const { DeviceEventEmitter } = require('react-native');
+const ReactNativeHeading = require('react-native-heading');
+
+//....
+  componentDidMount() {
+    ReactNativeHeading.start(1)
+	.then(didStart => {
+		this.setState({
+			headingIsSupported: didStart,
+		})
+	})
+
+    DeviceEventEmitter.addListener('headingUpdated', data => {
+    	console.log('New heading is:', data.heading);
+    });
 
+  }
+  componentWillUnmount() {
+  	ReactNativeHeading.stop();
+  	DeviceEventEmitter.removeAllListeners('headingUpdated');
+  }
+//...
 ```
 
 
 ####API
 
-`initialize(uuidString, username)` - Initialize the Discovery object with a UUID specific to your app, and a username specific to your device.
-
-`setPaused(isPaused)` - bool. pauses advertising and detection
-
-`setShouldDiscover(shouldDiscover)` - bool. starts and stops discovery only
-
-`setShouldAdvertise(shouldAdvertise)` - bool. starts and stops advertising only
-
-`setUserTimeoutInterval(userTimeoutInterval)` - integer in seconds, default is 5. After not seeing a user for x seconds, we remove him from the users list in our callback.
-
-
-*The following two methods are specific to the Android version, since the Android docs advise against continuous scanning. Instead, we cycle scanning on and off. This also allows us to modify the scan behaviour when the app moves to the background.*
+`start(filter)` - Start receiving heading updates. Accepts an optional filter param (int) to ignore heading changes less than the spcified threshold. The default value is 5. Returns a promise which can be used to determine if heading updates are suported by the device.
 
-`setScanForSeconds(scanForSeconds)` - integer in seconds, default is 5. This parameter specifies the duration of the ON part of the scan cycle.
-
-`setWaitForSeconds(waitForSeconds)` - integer in seconds default is 5. This parameter specifies the duration of the OFF part of the scan cycle.
+`stop` - Stop receiving heaing updates (don't forget to remove the `headingUpdated` listener)
 
 
 ##Setup
 
 ````
-npm install --save react-native-discovery
+npm install --save react-native-heading
 ````
 
 ###iOS
-* Run open node_modules/react-native-discovery
-* Drag ReactNativeDiscovery.xcodeproj into your Libraries group
+* Run open node_modules/react-native-heading
+* Drag ReactNativeHeading.xcodeproj into your Libraries group
 
 ###Android
 #####Step 1 - Update Gradle Settings
@@ -70,8 +55,8 @@ npm install --save react-native-discovery
 // file: android/settings.gradle
 ...
 
-include ':react-native-discovery'
-project(':react-native-discovery').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-discovery/android')
+include ':react-native-heading'
+project(':react-native-heading').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-heading/android')
 ```
 #####Step 2 - Update Gradle Build
 
@@ -81,13 +66,13 @@ project(':react-native-discovery').projectDir = new File(rootProject.projectDir,
 
 dependencies {
     ...
-    compile project(':react-native-discovery')
+    compile project(':react-native-heading')
 }
 ```
 #####Step 3 - Register React Package
 ```
 ...
-import com.joshblour.reactnativediscovery.ReactNativeDiscoveryPackage; // <--- import
+import com.joshblour.reactnativeheading.ReactNativeHeadingPackage; // <--- import
 
 public class MainActivity extends ReactActivity {