-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.md
40 lines (29 loc) · 1.43 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
[![Pub Version](https://img.shields.io/pub/v/version_tracker)](https://pub.dev/packages/version_tracker)
[![GitHub](https://img.shields.io/github/license/KevMorelli/version_tracker)](https://github.com/KevMorelli/version_tracker/blob/main/LICENSE)
# VersionTracker
Local version and build tracker plugin. Provides the ability to keep track of previous installations and easily migrate data between upgrades.
## Usage
Call this on the main function
```dart
var vt = VersionTracker();
await vt.track();
```
You can also set the max number for version and build history by giving a value to ``buildHistoryMaxLength`` and ``versionHistoryMaxLength`` in the track function.
```dart
var vt = VersionTracker();
await vt.track(buildHistoryMaxLength: 10, versionHistoryMaxLength: 10);
```
Then call these whenever you want (in these examples the user has launched a bunch of previous versions, and this is the first time he's launched the new version 1.0.11):
```dart
vt.isFirstLaunchEver; // false
vt.isFirstLaunchForVersion; // true
vt.isFirstLaunchForBuild; // true
vt.currentVersion; // 1.0.11
vt.previousVersion; // 1.0.10
vt.firstInstalledVersion; // 1.0.0
vt.versionHistory; // [ 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.10, 1.0.11 ]
vt.currentBuild; // 18
vt.previousBuild; // 15
vt.firstInstalledBuild; // 1
vt.buildHistory; // [ 1, 2, 3, 4, 5, 8, 9, 10, 11, 13, 15, 18 ]
```