diff --git a/README.md b/README.md index 6930465..f955e98 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ React Native module for iOS & Android to receive compass heading ## Installation -`$ yarn add react-native-compass-heading` - -`$ npx pod-install` +```shell +$ yarn add react-native-compass-heading +$ npx pod-install +``` ## Usage ```javascript @@ -15,9 +16,6 @@ import CompassHeading from 'react-native-compass-heading'; React.useEffect(() => { const degree_update_rate = 3; - // accuracy on android will be hardcoded to 1 - // since the value is not available. - // For iOS, it is in degrees CompassHeading.start(degree_update_rate, ({heading, accuracy}) => { console.log('CompassHeading: ', heading, accuracy); }); @@ -28,6 +26,6 @@ import CompassHeading from 'react-native-compass-heading'; }, []); ``` -# Acknowledgements +## Acknowledgements Thanks to the authors of react-native-simple-compass for inspiration