Rename android package, add readme instructions

README.md

@@ -1 +1,97 @@
 # react-native-safe-area-context
+
+A flexible way to handle safe area, also works on Android!
+
+## Getting started
+
+Install the library using either Yarn:
+
+```
+yarn add react-native-safe-area-context
+```
+
+or npm:
+
+```
+npm install --save react-native-safe-area-context
+```
+
+You then need to link the native parts of the library for the platforms you are using. The easiest way to link the library is using the CLI tool by running this command from the root of your project:
+
+```
+react-native link react-native-safe-area-context
+```
+
+If you can't or don't want to use the CLI tool, you can also manually link the library using the instructions below (click on the arrow to show them):
+
+<details>
+<summary>Manually link the library on iOS</summary>
+
+Either follow the [instructions in the React Native documentation](https://facebook.github.io/react-native/docs/linking-libraries-ios#manual-linking) to manually link the framework or link using [Cocoapods](https://cocoapods.org) by adding this to your `Podfile`:
+
+```ruby
+pod 'react-native-safe-area-context', :path => '../node_modules/react-native-safe-area-context'
+```
+
+</details>
+
+<details>
+<summary>Manually link the library on Android</summary>
+
+Make the following changes:
+
+#### `android/settings.gradle`
+```groovy
+include ':react-native-safe-area-context'
+project(':react-native-safe-area-context').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-safe-area-context/android')
+```
+
+#### `android/app/build.gradle`
+```groovy
+dependencies {
+   ...
+   implementation project(':react-native-safe-area-context')
+}
+```
+
+#### `android/app/src/main/.../MainApplication.java`
+On top, where imports are:
+
+```java
+import com.th3rdwave.safeareacontext.SafeAreaContextPackage;
+```
+
+Add the `SafeAreaContextPackage` class to your list of exported packages.
+
+```java
+@Override
+protected List<ReactPackage> getPackages() {
+    return Arrays.asList(
+            new MainReactPackage(),
+            new SafeAreaContextPackage()
+    );
+}
+```
+</details>
+
+## Example
+
+```js
+import React from 'react';
+import { View } from 'react-native';
+import { SafeAreaProvider, useSafeArea } from 'react-native-safe-area-context';
+
+function SomeComponent() {
+  const insets = useSafeArea();
+
+  return <View style={{ paddingTop: insets.top }} />;
+}
+
+function App() {
+  return (
+    <SafeAreaProvider>
+      <SomeComponent />
+    </SafeAreaProvider>
+  );
+}
+```

android/src/main/AndroidManifest.xml

@@ -1,6 +1,6 @@
 
 <manifest
 	xmlns:android="http://schemas.android.com/apk/res/android"
-	package="com.th3rdwave.safeareaview">
+	package="com.th3rdwave.safeareacontext">
 
 </manifest>

android/src/main/java/com/th3rdwave/safeareaview/EdgeInsets.java → android/src/main/java/com/th3rdwave/safeareacontext/EdgeInsets.java

@@ -1,4 +1,4 @@
-package com.th3rdwave.safeareaview;
+package com.th3rdwave.safeareacontext;
 
 /* package */ class EdgeInsets {
   public float top;

android/src/main/java/com/th3rdwave/safeareaview/InsetsChangeEvent.java → android/src/main/java/com/th3rdwave/safeareacontext/InsetsChangeEvent.java

@@ -1,4 +1,4 @@
-package com.th3rdwave.safeareaview;
+package com.th3rdwave.safeareacontext;
 
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.WritableMap;

android/src/main/java/com/th3rdwave/safeareaview/SafeAreaViewPackage.java → android/src/main/java/com/th3rdwave/safeareacontext/SafeAreaContextPackage.java

@@ -1,4 +1,4 @@
-package com.th3rdwave.safeareaview;
+package com.th3rdwave.safeareacontext;
 
 import com.facebook.react.ReactPackage;
 import com.facebook.react.bridge.NativeModule;
@@ -10,7 +10,7 @@ import java.util.List;
 
 import javax.annotation.Nonnull;
 
-public class SafeAreaViewPackage implements ReactPackage {
+public class SafeAreaContextPackage implements ReactPackage {
 
   @Nonnull
   @Override
@@ -23,4 +23,5 @@ public class SafeAreaViewPackage implements ReactPackage {
   public List<ViewManager> createViewManagers(@Nonnull ReactApplicationContext reactContext) {
     return Collections.<ViewManager>singletonList(new SafeAreaViewManager());
   }
+
 }

android/src/main/java/com/th3rdwave/safeareaview/SafeAreaView.java → android/src/main/java/com/th3rdwave/safeareacontext/SafeAreaView.java

@@ -1,4 +1,4 @@
-package com.th3rdwave.safeareaview;
+package com.th3rdwave.safeareacontext;
 
 import android.app.Activity;
 import android.content.Context;
@@ -7,7 +7,6 @@ import android.os.Build;
 import android.view.Surface;
 import android.view.View;
 import android.view.ViewTreeObserver;
-import android.view.Window;
 import android.view.WindowInsets;
 import android.view.WindowManager;
 

android/src/main/java/com/th3rdwave/safeareaview/SafeAreaViewManager.java → android/src/main/java/com/th3rdwave/safeareacontext/SafeAreaViewManager.java

@@ -1,4 +1,4 @@
-package com.th3rdwave.safeareaview;
+package com.th3rdwave.safeareacontext;
 
 import com.facebook.react.common.MapBuilder;
 import com.facebook.react.uimanager.ThemedReactContext;

example/android/app/src/main/java/com/safeareaviewexample/MainApplication.java

@@ -7,7 +7,7 @@ import com.facebook.react.ReactNativeHost;
 import com.facebook.react.ReactPackage;
 import com.facebook.react.shell.MainReactPackage;
 import com.facebook.soloader.SoLoader;
-import com.th3rdwave.safeareaview.SafeAreaViewPackage;
+import com.th3rdwave.safeareacontext.SafeAreaContextPackage;
 
 import java.util.Arrays;
 import java.util.List;
@@ -24,7 +24,7 @@ public class MainApplication extends Application implements ReactApplication {
     protected List<ReactPackage> getPackages() {
       return Arrays.asList(
           new MainReactPackage(),
-          new SafeAreaViewPackage());
+          new SafeAreaContextPackage());
     }
 
     @Override

package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-safe-area-context",
   "version": "0.1.0",
-  "description": "A more flexible <SafeAreaView>",
+  "description": "A flexible way to handle safe area, also works on Android.",
   "main": "src/index.tsx",
   "files": [
     "/android",