Fixed discrepancies with function naming, please check the readme.

Author: 8BallBomBom

README.md

@@ -6,35 +6,47 @@
 A simple React-Native utils library with useful functions.  
 Currently only supporting Android 4.1+, iOS might come later.  
 
-## Quick Start:
+## Quick Start
+
 In a lot of cases if you are using the latest version of React Native then you should be able to run one of the preferred package install methods and immediately get going.
 
 **npm**: `npm install react-native-app-utils`  
 **yarn**: `yarn add react-native-app-utils`  
 
-## Installation:
+## Installation
 
 Inside `android/app/src/main/AndroidManifest.xml` add this permission if you intend to use the wake lock functions.
+
 ```xml
 <uses-permission android:name="android.permission.WAKE_LOCK" />
 ```
+
 ### React Native 0.60+
+
 You won't usually need to do anything past this point, everything should just link up using the new autolinking feature.
 
-### Older React Native Versions:
+### Older React Native Versions
+
 You should be able to run the following command to get everything linked up.  
 `react-native link react-native-app-utils`  
 
 **If for some reason that doesn't work then you can follow the manual linking steps below.**
 
-1) Inside `android/app/build.gradle` add this line `implementation project(':react-native-app-utils')` in the dependencies {} section.
+Inside `android/app/build.gradle` add the following line in the existing dependencies section.
 
-2) Inside `android/settings.gradle` add these lines.
+```gradle
+implementation project(':react-native-app-utils')
 ```
+
+Inside `android/settings.gradle` add these lines to the bottom of the file.
+
+```gradle
 include ':react-native-app-utils'
 project(':react-native-app-utils').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-app-utils/android')
 ```
-3) Inside `MainApplication.java` import and add our package to the list.
+
+Inside `MainApplication.java` import and add our package to the existing package list.
+
 ```java
 import com.stumbleapp.utils.UtilsPackage;
 
@@ -45,46 +57,54 @@ private static List<ReactPackage> getPackages() {
 
     );
 }
-```   
-   
-## Usage:
-Here is a general rundown of the included functions and examples of their use.   
-Lets get our module imported.
+```
+
+## Usage
+
+Here is a general rundown of the included functions and examples of their use.
+Let's get the module imported so we can actually use it.
+
 ```javascript
 import Utils from 'react-native-app-utils';
-```   
-   
+```
+
 This will essentially move your app to the front if it's already running, otherwise it will get the app to start.
 I'm not entirely sure how this would pan out on some devices, theres a chance it won't work on any that restrict starting apps from background services. The reason i wanted this kind of function though was to get our app to start when there was an incoming call notification triggered by Firebase.
+
 ```javascript
 Utils.startApp();
-```   
-   
+```
+
 This will make your app goto the background. Very useful if you use the above function to start your app but then want to put the app back to sleep in the background. Our use case for this was simply for when a call came in, the app would start but if the call went unanswered for a while then we would leave a missed call notification and hide the app.
+
 ```javascript
 Utils.moveAppToBack();
-```   
-   
-If for any reason you want to keep the screen on while your app is running then you can use wake locks and screen locks. Make sure to release them if having the screen on isn't always a requirement of using your app, think about the battery usage! The first wake lock function should cause the screen to switch on, otherwise you can mix and match, try using a screen lock aswell. Last but not least you can use partial wake locks if you need the device to be alive while doing background work.
+```
+
+If for any reason you need to keep the screen on while your app is running then you can use wake locks and screen locks. Make sure to release them if having the screen on by force isn't always a requirement of using your app, think about the battery usage! The first wake lock function should cause the screen to switch on, otherwise you can mix and match, try using a screen lock aswell. Last but not least you can use partial wake locks if you need the device to be alive while doing background service work, not always a requirement as some modules will handle that themselvs.
+
 ```javascript
-Utils.acquireWakelock();
-Utils.releaseWakelock();
+Utils.acquireWakeLock();
+Utils.releaseWakeLock();
 
-Utils.acquirePartialWakelock();
-Utils.releasePartialWakelock();
+Utils.acquirePartialWakeLock();
+Utils.releasePartialWakeLock();
 
-Utils.aquireScreenLock();
+Utils.acquireScreenLock();
 Utils.releaseScreenLock();
-```   
-   
+```
+
 If for any reason you need to keep the wifi connection alive then you can use wifi locks. This does not prevent the user switching off their wifi connection manually. Best use case scenario would be if you need a connection for long periods due to background work or active interactions like a phone call.
+
 ```javascript
-Utils.aquireWifiLock();
+Utils.acquireWifiLock();
 Utils.releaseWifiLock();
-```   
-This is an experimental function that hasn't been fully implemented yet.   
-**Requires Android API 24+**   
+```
+
+This is an experimental function that hasn't been fully implemented yet.
+**Requires Android API 24+**
 We will be looking to add extra functionality to this soon.
+
 ```javascript
 Utils.enterPictureInPictureMode();
 ```

android/src/main/java/com/stumbleapp/utils/UtilsModule.java

@@ -147,7 +147,7 @@ public void moveAppToBack() {
 	}
 
 	@ReactMethod
-	public void acquireWakelock() {
+	public void acquireWakeLock() {
 		if ( wakeLock.isHeld() ) {
 			return;
 		}
@@ -165,7 +165,7 @@ public void releaseWakeLock() {
 	}
 
 	@ReactMethod
-	public void acquirePartialWakelock() {
+	public void acquirePartialWakeLock() {
 		if ( partialWakeLock.isHeld() ) {
 			return;
 		}
@@ -174,7 +174,7 @@ public void acquirePartialWakelock() {
 	}
 
 	@ReactMethod
-	public void releasePartialWakelock() {
+	public void releasePartialWakeLock() {
 		if ( !partialWakeLock.isHeld() ) {
 			return;
 		}

index.js

@@ -6,10 +6,10 @@ const UtilsModule = NativeModules.UtilsModule;
 
 function startApp() { return UtilsModule.startApp(); };
 function moveAppToBack() { return UtilsModule.moveAppToBack(); };
-function acquireWakelock() { return UtilsModule.acquireWakelock(); };
-function releaseWakelock() { return UtilsModule.releaseWakelock(); };
-function acquirePartialWakelock() { return UtilsModule.acquirePartialWakelock(); };
-function releasePartialWakelock() { return UtilsModule.releasePartialWakelock(); };
+function acquireWakeLock() { return UtilsModule.acquireWakeLock(); };
+function releaseWakeLock() { return UtilsModule.releaseWakeLock(); };
+function acquirePartialWakeLock() { return UtilsModule.acquirePartialWakeLock(); };
+function releasePartialWakeLock() { return UtilsModule.releasePartialWakeLock(); };
 function acquireScreenLock() { return UtilsModule.acquireScreenLock(); };
 function releaseScreenLock() { return UtilsModule.releaseScreenLock(); };
 function acquireWifiLock() { return UtilsModule.acquireWifiLock(); };
@@ -19,10 +19,10 @@ function enterPictureInPictureMode() { return UtilsModule.enterPictureInPictureM
 export default {
 	startApp: startApp,
 	moveAppToBack: moveAppToBack,
-	acquireWakelock: acquireWakelock,
-	releaseWakelock: releaseWakelock,
-	acquirePartialWakelock: acquirePartialWakelock,
-	releasePartialWakelock: releasePartialWakelock,
+	acquireWakeLock: acquireWakeLock,
+	releaseWakeLock: releaseWakeLock,
+	acquirePartialWakeLock: acquirePartialWakeLock,
+	releasePartialWakeLock: releasePartialWakeLock,
 	acquireScreenLock: acquireScreenLock,
 	releaseScreenLock: releaseScreenLock,
 	acquireWifiLock: acquireWifiLock,

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "react-native-app-utils",
-	"version": "0.1.4",
+	"version": "0.1.5",
 	"description": "A simple React-Native utils library with useful functions.",
 	"nativePackage": true,
 	"main": "index.js",