6 update readme

README.md

@@ -1,6 +1,6 @@
 # react-native-neo-version
 
-Check the version for react native applications
+Notify users a new version of application is available and prompt them to upgrade.
 
 ## Installation
 
@@ -10,14 +10,45 @@ npm install react-native-neo-version
 
 ## Usage
 
-```js
-import { multiply } from 'react-native-neo-version';
+```ts
+import { useNeoVersionCheck } from 'react-native-neo-version';
 
 // ...
 
-const result = await multiply(3, 7);
+export default function App() {
+  useNeoVersionCheck();
+
+  return (
+    <View style={styles.container}>
+      <Text>React Native Neo Version</Text>
+    </View>
+  );
+}
+```
+
+You can change the behaviour by configuration
+
+```ts
+import { useNeoVersionCheck } from 'react-native-neo-version';
+
+// ...
+useNeoVersionCheck({
+  frequency: 20,
+  alertType: 'force',
+  title: 'alert title',
+  message: 'alert meessage',
+});
 ```
 
+## Screenshots
+
+### iOS
+- The left picture forces the user to update the app.
+- The center picture gives the user the option to update the app.
+- The right picture gives the user the option to skip the current update.
+
+### Android
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
@@ -26,6 +57,3 @@ See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the
 
 MIT
 
----
-
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)