docs: reformat README using prettier

Device Information for [React Native](https://github.com/facebook/react-native).

Device Information for [React Native](https://github.com/facebook/react-native).

## TOC

## TOC

* [Installation](#installation)

* [Installation](#installation)

* [Linking](#linking)

* [Linking](#linking)

* [Usage](#usage)

* [Usage](#usage)

`pod 'RNDeviceInfo', :path => '../node_modules/react-native-device-info'`

`pod 'RNDeviceInfo', :path => '../node_modules/react-native-device-info'`

Then run `pod install`

Then run `pod install`

</details>

</details>

<details>

<details>

    <summary>iOS (without Cocoa Pods)</summary>

    <summary>iOS (without Cocoa Pods)</summary>

In XCode, in the project navigator:

In XCode, in the project navigator:

- Right click _Libraries_

- Add Files to _[your project's name]_

* Right click _Libraries_

- Go to `node_modules/react-native-device-info`

* Add Files to _[your project's name]_

- Add the `.xcodeproj` file

* Go to `node_modules/react-native-device-info`

* Add the `.xcodeproj` file

In XCode, in the project navigator, select your project.

In XCode, in the project navigator, select your project.

- Add the `libRNDeviceInfo.a` from the _deviceinfo_ project to your project's _Build Phases ➜ Link Binary With Libraries_

- Click `.xcodeproj` file you added before in the project navigator and go the _Build Settings_ tab. Make sure _All_ is toggled on (instead of _Basic_).

* Add the `libRNDeviceInfo.a` from the _deviceinfo_ project to your project's _Build Phases ➜ Link Binary With Libraries_

- Look for _Header Search Paths_ and make sure it contains both `$(SRCROOT)/../react-native/React` and `$(SRCROOT)/../../React`

* Click `.xcodeproj` file you added before in the project navigator and go the _Build Settings_ tab. Make sure _All_ is toggled on (instead of _Basic_).

- Mark both as recursive (should be OK by default).

* Look for _Header Search Paths_ and make sure it contains both `$(SRCROOT)/../react-native/React` and `$(SRCROOT)/../../React`

* Mark both as recursive (should be OK by default).

Run your project (Cmd+R)

Run your project (Cmd+R)

(Thanks to @brysgo for writing the instructions)

(Thanks to @brysgo for writing the instructions)

</details>

</details>

<details>

<details>

    <summary>Android</summary>

    <summary>Android</summary>

- in `android/app/build.gradle`:

* in `android/app/build.gradle`:

```diff

```diff

dependencies {

dependencies {

}

}

```

```

- in `android/settings.gradle`:

* in `android/settings.gradle`:

```diff

```diff

...

...

#### With React Native 0.29+

#### With React Native 0.29+

- in `MainApplication.java`:

* in `MainApplication.java`:

```diff

```diff

+ import com.learnium.RNDeviceInfo.RNDeviceInfo;

+ import com.learnium.RNDeviceInfo.RNDeviceInfo;

#### With older versions of React Native:

#### With older versions of React Native:

- in `MainActivity.java`:

* in `MainActivity.java`:

```diff

```diff

+ import com.learnium.RNDeviceInfo.RNDeviceInfo;

+ import com.learnium.RNDeviceInfo.RNDeviceInfo;

```

```

(Thanks to @chirag04 for writing the instructions)

(Thanks to @chirag04 for writing the instructions)

</details>

</details>

<details>

<details>

    <summary>Windows</summary>

    <summary>Windows</summary>

- Open the solution in Visual Studio for your Windows apps

* Open the solution in Visual Studio for your Windows apps

- right click your in the Explorer and click Add > Existing Project...

* right click your in the Explorer and click Add > Existing Project...

- Navigate to `./<app-name>/node_modules/react-native-device-info/windows/RNDeviceInfo` and add `RNDeviceInfo.csproj`

* Navigate to `./<app-name>/node_modules/react-native-device-info/windows/RNDeviceInfo` and add `RNDeviceInfo.csproj`

- this time right click on your React Native Windows app under your solutions directory and click Add > Reference...

* this time right click on your React Native Windows app under your solutions directory and click Add > Reference...

- check the `RNDeviceInfo` you just added and press ok

* check the `RNDeviceInfo` you just added and press ok

- open up `MainPage.cs` for your app and edit the file like so:

* open up `MainPage.cs` for your app and edit the file like so:

```diff

```diff

+ using RNDeviceInfo;

+ using RNDeviceInfo;

```

```

(Thanks to @josephan for writing the instructions)

(Thanks to @josephan for writing the instructions)

</details>

</details>

## Usage

## Usage

```js

```js

var DeviceInfo = require('react-native-device-info');

var DeviceInfo = require("react-native-device-info");

// or import DeviceInfo from 'react-native-device-info';

// or import DeviceInfo from 'react-native-device-info';

```

```

## API

## API

| Method                                            | Return Type         |  iOS | Android | Windows | Since  |

| Method                                            | Return Type         |  iOS | Android | Windows | Since  |

| ------------------------------------------------- | ------------------- | :---------: | :-----: | :-----: | ------ |

| ------------------------------------------------- | ------------------- | :--: | :-----: | :-----: | ------ |

| [getAPILevel()](#getapilevel)                     | `number`            |  ❌  |   ✅    |   ❌    | 0.12.0 |

| [getAPILevel()](#getapilevel)                     | `number`            |  ❌  |   ✅    |   ❌    | 0.12.0 |

| [getApplicationName()](#getapplicationname)       | `string`            |  ✅  |   ✅    |   ✅    | 0.14.0 |

| [getApplicationName()](#getapplicationname)       | `string`            |  ✅  |   ✅    |   ✅    | 0.14.0 |

| [getBrand()](#getbrand)                           | `string`            |  ✅  |   ✅    |   ✅    | 0.9.3  |

| [getBrand()](#getbrand)                           | `string`            |  ✅  |   ✅    |   ✅    | 0.9.3  |

| [getVersion()](#getversion)                       | `string`            |  ✅  |   ✅    |   ✅    | ?      |

| [getVersion()](#getversion)                       | `string`            |  ✅  |   ✅    |   ✅    | ?      |

| [is24Hour()](#is24hour)                           | `boolean`           |  ✅  |   ✅    |   ✅    | 0.13.0 |

| [is24Hour()](#is24hour)                           | `boolean`           |  ✅  |   ✅    |   ✅    | 0.13.0 |

| [isEmulator()](#isemulator)                       | `boolean`           |  ✅  |   ✅    |   ✅    | ?      |

| [isEmulator()](#isemulator)                       | `boolean`           |  ✅  |   ✅    |   ✅    | ?      |

| [isPinOrFingerprintSet()](#ispinorfingerprintset) | (callback)`boolean` | ✅(iOS 9+) | ✅      | ❌      | 0.10.1 |

| [isPinOrFingerprintSet()](#ispinorfingerprintset) | (callback)`boolean` |  ✅  |   ✅    |   ❌    | 0.10.1 |

| [isTablet()](#istablet)                           | `boolean`           |  ✅  |   ✅    |   ✅    | ?      |

| [isTablet()](#istablet)                           | `boolean`           |  ✅  |   ✅    |   ✅    | ?      |

---

---

### getAPILevel()

### getAPILevel()

Gets the API level.

Gets the API level.

**Examples**

**Examples**

```js

```js

const apiLevel = DeviceInfo.getAPILevel();

const apiLevel = DeviceInfo.getAPILevel();

```

```

**Notes**

**Notes**

> See [API Levels](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

> See [API Levels](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

---

---

### getApplicationName()

### getApplicationName()

Gets the application name.

Gets the application name.

**Examples**

**Examples**

```js

```js

const appName = DeviceInfo.getApplicationName(); // "Learnium Mobile"

const appName = DeviceInfo.getApplicationName(); // "Learnium Mobile"

```

```

---

---

### getBrand()

### getBrand()

Gets the device brand.

Gets the device brand.

**Examples**

**Examples**

```js

```js

const brand = DeviceInfo.getBrand();

const brand = DeviceInfo.getBrand();

---

---

### getBuildNumber()

### getBuildNumber()

Gets the application build number.

Gets the application build number.

**Examples**

**Examples**

```js

```js

const buildNumber = DeviceInfo.getBuildNumber();

const buildNumber = DeviceInfo.getBuildNumber();

```

```

**Notes**

**Notes**

> There is a type inconsistency: Android return an integer instead of the documented string.

> There is a type inconsistency: Android return an integer instead of the documented string.

---

---

### getBundleId()

### getBundleId()

Gets the application bundle identifier.

Gets the application bundle identifier.

**Examples**

**Examples**

```js

```js

const bundleId = DeviceInfo.getBundleId(); // "com.learnium.mobile"

const bundleId = DeviceInfo.getBundleId(); // "com.learnium.mobile"

```

```

---

---

### getCarrier()

### getCarrier()

Gets the carrier name (network operator).

Gets the carrier name (network operator).

**Examples**

**Examples**

```js

```js

const carrier = DeviceInfo.getCarrier(); // "SOFTBANK"

const carrier = DeviceInfo.getCarrier(); // "SOFTBANK"

```

```

---

---

### getDeviceCountry()

### getDeviceCountry()

Gets the device country based on the locale information.

Gets the device country based on the locale information.

**Examples**

**Examples**

```js

```js

const deviceCountry = DeviceInfo.getDeviceCountry(); // "US"

const deviceCountry = DeviceInfo.getDeviceCountry(); // "US"

```

```

---

---

### getDeviceId()

### getDeviceId()

Gets the device ID.

Gets the device ID.

**Examples**

**Examples**

```js

```js

const deviceId = DeviceInfo.getDeviceId();

const deviceId = DeviceInfo.getDeviceId();

---

---

### getDeviceLocale()

### getDeviceLocale()

Gets the device locale.

Gets the device locale.

**Examples**

**Examples**

```js

```js

const deviceLocale = DeviceInfo.getDeviceLocale();

const deviceLocale = DeviceInfo.getDeviceLocale();

---

---

### getDeviceName()

### getDeviceName()

Gets the device name.

Gets the device name.

**Examples**

**Examples**

```js

```js

const deviceName = DeviceInfo.getDeviceName();

const deviceName = DeviceInfo.getDeviceName();

```

```

**Android Permissions**

**Android Permissions**

* [android.permission.BLUETOOTH](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH)

* [android.permission.BLUETOOTH](https://developer.android.com/reference/android/Manifest.permission.html#BLUETOOTH)

---

---

### getFirstInstallTime()

### getFirstInstallTime()

Gets the time at which the app was first installed, in milliseconds.

Gets the time at which the app was first installed, in milliseconds.

**Examples**

**Examples**

```js

```js

const firstInstallTime = DeviceInfo.getFirstInstallTime();

const firstInstallTime = DeviceInfo.getFirstInstallTime();

---

---

### getIPAddress()

### getIPAddress()

Gets the device current IP address.

Gets the device current IP address.

**Examples**

**Examples**

```js

```js

DeviceInfo.getIPAddress().then(ip => {

DeviceInfo.getIPAddress().then(ip => {

  // "92.168.32.44"

  // "92.168.32.44"

})

});

```

```

**Android Permissions**

**Android Permissions**

* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

---

---

### getInstanceID()

### getInstanceID()

Gets the application instance ID.

Gets the application instance ID.

**Examples**

**Examples**

```js

```js

const instanceId = DeviceInfo.getInstanceID();

const instanceId = DeviceInfo.getInstanceID();

```

```

**Notes**

**Notes**

> See https://developers.google.com/instance-id/

> See https://developers.google.com/instance-id/

---

---

### getLastUpdateTime()

### getLastUpdateTime()

Gets the time at which the app was last updated, in milliseconds.

Gets the time at which the app was last updated, in milliseconds.

**Examples**

**Examples**

```js

```js

const lastUpdateTime = DeviceInfo.getLastUpdateTime();

const lastUpdateTime = DeviceInfo.getLastUpdateTime();

---

---

### getMACAddress()

### getMACAddress()

Gets the network adapter MAC address.

Gets the network adapter MAC address.

**Examples**

**Examples**

```js

```js

DeviceInfo.getMACAddress().then(mac => {

DeviceInfo.getMACAddress().then(mac => {

  // "E5:12:D8:E5:69:97"

  // "E5:12:D8:E5:69:97"

})

});

```

```

**Android Permissions**

**Android Permissions**

* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

---

---

### getManufacturer()

### getManufacturer()

Gets the device manufacturer.

Gets the device manufacturer.

**Examples**

**Examples**

```js

```js

const manufacturer = DeviceInfo.getManufacturer();

const manufacturer = DeviceInfo.getManufacturer();

---

---

### getMaxMemory()

### getMaxMemory()

Returns the maximum amount of memory that the JVM will attempt to use, in bytes.

Returns the maximum amount of memory that the JVM will attempt to use, in bytes.

**Examples**

**Examples**

```js

```js

const maxMemory = DeviceInfo.getMaxMemory();

const maxMemory = DeviceInfo.getMaxMemory();

---

---

### getModel()

### getModel()

Gets the device model.

Gets the device model.

**Examples**

**Examples**

```js

```js

const model = DeviceInfo.getModel();

const model = DeviceInfo.getModel();

---

---

### getPhoneNumber()

### getPhoneNumber()

Gets the device phone number.

Gets the device phone number.

**Examples**

**Examples**

```js

```js

const phoneNumber = DeviceInfo.getPhoneNumber();

const phoneNumber = DeviceInfo.getPhoneNumber();

```

```

**Android Permissions**

**Android Permissions**

* [android.permission.READ_PHONE_STATE](https://developer.android.com/reference/android/Manifest.permission.html#READ_PHONE_STATE)

* [android.permission.READ_PHONE_STATE](https://developer.android.com/reference/android/Manifest.permission.html#READ_PHONE_STATE)

---

---

### getReadableVersion()

### getReadableVersion()

Gets the application human readable version.

Gets the application human readable version.

**Examples**

**Examples**

```js

```js

const readableVersion = DeviceInfo.getReadableVersion();

const readableVersion = DeviceInfo.getReadableVersion();

---

---

### getSerialNumber()

### getSerialNumber()

Gets the device serial number.

Gets the device serial number.

**Examples**

**Examples**

```js

```js

const serialNumber = DeviceInfo.getSerialNumber();

const serialNumber = DeviceInfo.getSerialNumber();

---

---

### getSystemName()

### getSystemName()

Gets the device OS name.

Gets the device OS name.

**Examples**

**Examples**

```js

```js

const systemName = DeviceInfo.getSystemName();

const systemName = DeviceInfo.getSystemName();

---

---

### getSystemVersion()

### getSystemVersion()

Gets the device OS version.

Gets the device OS version.

**Examples**

**Examples**

```js

```js

const systemVersion = DeviceInfo.getSystemVersion();

const systemVersion = DeviceInfo.getSystemVersion();

---

---

### getTimezone()

### getTimezone()

Gets the device default timezone.

Gets the device default timezone.

**Examples**

**Examples**

```js

```js

const timezone = DeviceInfo.getTimezone(); // "Africa/Tunis"

const timezone = DeviceInfo.getTimezone(); // "Africa/Tunis"

```

```

---

---

### getTotalMemory()

### getTotalMemory()

Gets the device total memory, in bytes.

Gets the device total memory, in bytes.

**Examples**

**Examples**

```js

```js

const totalMemory = DeviceInfo.getTotalMemory();

const totalMemory = DeviceInfo.getTotalMemory();

---

---

### getUniqueID()

### getUniqueID()

Gets the device unique ID.

Gets the device unique ID.

**Examples**

**Examples**

```js

```js

const uniqueId = DeviceInfo.getUniqueId();

const uniqueId = DeviceInfo.getUniqueId();

```

```

**Notes**

**Notes**

> This is IDFV on iOS so it will change if all apps from the current apps vendor have been previously uninstalled.

> This is IDFV on iOS so it will change if all apps from the current apps vendor have been previously uninstalled.

---

---

### getUserAgent()

### getUserAgent()

Gets the device User Agent.

Gets the device User Agent.

**Examples**

**Examples**

```js

```js

const userAgent = DeviceInfo.getUserAgent();

const userAgent = DeviceInfo.getUserAgent();

---

---

### getVersion()

### getVersion()

Gets the application version.

Gets the application version.

**Examples**

**Examples**

```js

```js

const version = DeviceInfo.getVersion();

const version = DeviceInfo.getVersion();

---

---

### is24Hour()

### is24Hour()

Tells if the user preference is set to 24-hour format.

Tells if the user preference is set to 24-hour format.

**Examples**

**Examples**

```js

```js

const is24Hour = DeviceInfo.is24Hour(); // true

const is24Hour = DeviceInfo.is24Hour(); // true

```

```

---

---

### isEmulator()

### isEmulator()

Tells if the application is running in an emulator.

Tells if the application is running in an emulator.

**Examples**

**Examples**

```js

```js

const isEmulator = DeviceInfo.isEmulator(); // false

const isEmulator = DeviceInfo.isEmulator(); // false

```

```

---

---

### isPinOrFingerprintSet()

### isPinOrFingerprintSet()

Tells if a PIN number or a fingerprint was set for the device.

Tells if a PIN number or a fingerprint was set for the device.

**Examples**

**Examples**

```js

```js

DeviceInfo.isPinOrFingerprintSet()(isPinOrFingerprintSet => {

DeviceInfo.isPinOrFingerprintSet()(isPinOrFingerprintSet => {

  if (!isPinOrFingerprintSet) {

  if (!isPinOrFingerprintSet) {

```

```

**Notes**

**Notes**

> Since the device setting for PIN/Fingerprint can be modified while the app is still open, this is available via callback instead of as a constant.

> * Since the device setting for PIN/Fingerprint can be modified while the app is still open, this is available via callback instead of as a constant.

> * iOS: Not supported for iOS < 9

---

---

### isTablet()

### isTablet()

Tells if the device is a tablet.

Tells if the device is a tablet.

**Examples**

**Examples**

```js

```js

const isTablet = DeviceInfo.isTablet(); // true

const isTablet = DeviceInfo.isTablet(); // true

```

```