version 2.0.0

Author: bebnev

README.md

@@ -1,62 +1,55 @@
 
-# react-native-user-agent
+# React Native User Agent
 
-## Getting started
+## Platforms Supported
 
-Install with [npm](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/):
+- [x] iOS
+- [x] Android
 
-npm:
-```sh
-npm install react-native-user-agent --save
-```
+## Getting Started Guide
+
+1. Add react-native-user-agent to your dependencies
 
-Yarn:
 ```sh
 yarn add react-native-user-agent
 ```
 
-### Mostly automatic installation
+or, for npm use
 
-`$ react-native link react-native-user-agent`
+```sh
+npm install react-native-user-agent --save
+```
 
-After that, add this to your `Podfile` and run `pod install`
+2. Link native dependencies
 
-```
-pod 'RNUserAgent', :path => '../node_modules/react-native-user-agent/ios'
-```
+2.1 **react-native >= 0.60**
 
-### Manual installation
+Autolinking will take care of the link step, but for iOS, don't forget to run `pod install` in `ios/` folder
 
+If you haven't set up cocoapods yet, please refer to [that article](https://engineering.brigad.co/demystifying-react-native-modules-linking-ae6c017a6b4a)
 
-#### iOS
+2.2 **react-native < 0.60**
 
-1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
-2. Go to `node_modules` ➜ `react-native-user-agent` and add `RNUserAgent.xcodeproj`
-3. In XCode, in the project navigator, select your project. Add `libRNUserAgent.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
-4. Run your project (`Cmd+R`)<
+You have to call `link` command manualy:
 
-#### Android
+```sh
+react-native link react-native-user-agent
+```
 
-1. Open up `android/app/src/main/java/[...]/MainApplication.java`
-  - Add `import com.bebnev.RNUserAgentPackage;` to the imports at the top of the file
-  - Add `new RNUserAgentPackage()` to the list returned by the `getPackages()` method
-2. Append the following lines to `android/settings.gradle`:
-  	```
-  	include ':react-native-user-agent'
-  	project(':react-native-user-agent').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-user-agent/android')
-  	```
-3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
-  	```
-      compile project(':react-native-user-agent')
-  	```
+*For manual linking*, please refer to:
+- [that article](https://engineering.brigad.co/demystifying-react-native-modules-linking-964399ec731b) for Android
+- [react-native own tutorial](https://facebook.github.io/react-native/docs/linking-libraries-ios) for iOS
 
 ## Usage
 
 ```javascript
 import UserAgent from 'react-native-user-agent';
 
-UserAgent.getUserAgent();
-UserAgent.getWebViewUserAgent();
+UserAgent.getUserAgent(); //synchronous
+
+UserAgent.getWebViewUserAgent() //asynchronous
+    .then(ua => {})
+    .catch(e => {})
 ```
 
 ### Examples:
@@ -66,27 +59,32 @@ UserAgent.getWebViewUserAgent();
 | iOS    | application-name/1.6.4.176 CFNetwork/897.15 Darwin/17.5.0 (iPhone/6s iOS/11.3) | Mozilla/5.0 (iPhone; CPU iPhone OS 11_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E217 |
 | Android | application-name/1.6.7.42 Dalvik/2.1.0 (Linux; U; Android 5.1.1; Android SDK built for x86 Build/LMY48X) | Mozilla/5.0 (Linux; Android 5.1.1; Android SDK built for x86 Build/LMY48X) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/39.0.0.0 Mobile Safari/537.36 |
 
-### Additionally:
+Additionally module returns a set of constants, that are used in user agent string building.
 
-Every version returns some constants that are used in user agent string building.
-
-iOS version returns:
+For iOS:
 - systemName
 - systemVersion
 - applicationName
 - applicationVersion
-- applicationBuildNumber
+- buildNumber
 - darwinVersion
 - cfnetworkVersion
-- deviceName
+- deviceName **deprecated**
+- modelName
 
-Android version returns:
+For Android:
 - systemName
 - systemVersion
 - applicatioName
 - applicationVersion
-- applicationBuildNumber
+- buildNumber
+
+## Versioning
+
+**Breaking History:**
 
+- [2.0.0](https://github.com/bebnev/react-native-user-agent/releases/tag/v2.0.0) - supports [autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md), native code refactoring, removes UIWebView, `getWebViewUserAgent()` returns promise
+- [1.0.6](https://github.com/bebnev/react-native-user-agent/releases/tag/v1.0.6) - First release
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-user-agent",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "Library that helps you to get mobile application user agent and web view user agent strings.",
   "main": "index.js",
   "repository": {