Skip to content

Commit e0dd7e7

Browse files
authored
Update README.md
1 parent 9b8aff7 commit e0dd7e7

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,20 +53,34 @@ protected List<ReactPackage> getPackages() {
5353
```javascript
5454
import VersionCheck from 'react-native-version-check';
5555

56-
57-
console.log(VersionCheck.getCurrentVersion()); // 0.2.3
58-
console.log(VersionCheck.getLatestVersion()); // 0.2.4
59-
60-
61-
console.log(VersionCheck.needUpdate()); // true
62-
console.log(VersionCheck.needUpdate(2)); // false
56+
console.log(VersionCheck.getPackageName()); // com.reactnative.app
57+
console.log(VersionCheck.getCurrentBuildNumber()); // 10
58+
console.log(VersionCheck.getCurrentVersion()); // 0.1.1
59+
60+
VersionCheck.getLatestVersion()
61+
.then((latestVersion) => {
62+
console.log(latestVersion); // 0.1.2
63+
});
64+
65+
VersionCheck.needUpdate()
66+
.then((res) => {
67+
console.log(res.isNeeded); // true
68+
});
69+
70+
VersionCheck.needUpdate(2)
71+
.then((res) => {
72+
console.log(res.isNeeded); // false; because the second field of current and the lastest versions are the same as 1.
73+
});
74+
6375
```
6476

6577
## Methods
6678

79+
- **`getPackageName()`** _(String)_ - Returns package name of app.
80+
- **`getCurrentBuildNumber()`** _(Number)_ - Returns current app build number.
6781
- **`getCurrentVersion()`** _(String)_ - Returns current app version.
68-
- **`getLatestVersion()`** _(String)_ - Returns the latest app version parsed from market. Returns `null` when parsing error occurs.
69-
- **`needUpdate(depth : Number, delimiter : String)`** _(Bool)_ - Returns `true` if app needs update, `false` otherwise. Current and the latest app versions are first splitted by delimiter(`'.'` by default), and check each splitted numbers into depth(`Infinity` by default).
82+
- **`getLatestVersion()`** _(Promise)_ - Returns the latest app version parsed from market. Returns `null` when parsing error occurs.
83+
- **`needUpdate(depth : Number, delimiter : String)`** _(Promise)_ - Returns `{ isNeeded: true, version: latestVersion }` if app needs update, `{ isNeeded: false, version: latestVersion }` otherwise. Current and the latest app versions are first splitted by delimiter(`'.'` by default), and check each splitted numbers into depth(`Infinity` by default).
7084

7185
## License
7286
MIT

0 commit comments

Comments
 (0)