Showing
4 changed files
with
33 additions
and
9 deletions
| 1 | # Wakelock [](https://github.com/creativecreatorormaybenot/wakelock) [](https://pub.dev/packages/wakelock) [](https://twitter.com/creativemaybeno) | 1 | # Wakelock [](https://github.com/creativecreatorormaybenot/wakelock) [](https://pub.dev/packages/wakelock) [](https://twitter.com/creativemaybeno) |
| 2 | 2 | ||
| 3 | -Wakelock is Flutter plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on Android, iOS, and web. | 3 | +Wakelock is Flutter plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping. |
| 4 | + | ||
| 5 | +## Supported platforms | ||
| 6 | + | ||
| 7 | +| Platform | `wakelock` support | | ||
| 8 | +| :------- | :----------------: | | ||
| 9 | +| Android | ✅ | | ||
| 10 | +| iOS | ✅ | | ||
| 11 | +| Web | ✅ | | ||
| 12 | +| macOS | ⚒ work in progress | | ||
| 13 | +| Windows | ❎ planned | | ||
| 14 | +| Linux | ❎ planned | | ||
| 4 | 15 | ||
| 5 | ## Getting started | 16 | ## Getting started |
| 6 | 17 |
| 1 | +## 0.3.0-nullsafety.3 | ||
| 2 | + | ||
| 3 | +* Add supported platforms to README. | ||
| 4 | + | ||
| 1 | ## 0.3.0-nullsafety.2 | 5 | ## 0.3.0-nullsafety.2 |
| 2 | 6 | ||
| 3 | * Indicated that no permissions are required for using the `wakelock` plugin in the README. | 7 | * Indicated that no permissions are required for using the `wakelock` plugin in the README. |
| 1 | # wakelock [](https://pub.dev/packages/wakelock) [](https://github.com/creativecreatorormaybenot/wakelock) [](https://twitter.com/creativemaybeno) | 1 | # wakelock [](https://pub.dev/packages/wakelock) [](https://github.com/creativecreatorormaybenot/wakelock) [](https://twitter.com/creativemaybeno) |
| 2 | 2 | ||
| 3 | -Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on | ||
| 4 | -Android, iOS, and web. | 3 | +Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping |
| 5 | 4 | ||
| 6 | --- | 5 | --- |
| 7 | 6 | ||
| 8 | -The plugin allows you to enable and toggle the screen wakelock on Android, iOS, and web, which | ||
| 9 | -prevents the screen from turning off automatically. | 7 | +The plugin allows you to enable and toggle the screen wakelock, which prevents the screen from turning off automatically. |
| 10 | Essentially, this allows you to keep the device awake, i.e. prevent the device from sleeping. | 8 | Essentially, this allows you to keep the device awake, i.e. prevent the device from sleeping. |
| 11 | 9 | ||
| 10 | +## Supported platforms | ||
| 11 | + | ||
| 12 | +| Platform | `wakelock` support | | ||
| 13 | +| :------- | :----------------: | | ||
| 14 | +| Android | ✅ | | ||
| 15 | +| iOS | ✅ | | ||
| 16 | +| Web | ✅ | | ||
| 17 | +| macOS | ⚒ work in progress | | ||
| 18 | +| Windows | ❎ planned | | ||
| 19 | +| Linux | ❎ planned | | ||
| 20 | + | ||
| 12 | ## Usage | 21 | ## Usage |
| 13 | 22 | ||
| 14 | To use this plugin, follow the [installing guide](https://pub.dev/packages/wakelock/install). | 23 | To use this plugin, follow the [installing guide](https://pub.dev/packages/wakelock/install). |
| 15 | 24 | ||
| 16 | -The `wakelock` plugin **does not require any special *permissions*** on any platform :) | ||
| 17 | -This is because it only enables the *screen wakelock* and not any partial (CPU) wakelocks that would keep the app alive in the background. | 25 | +The `wakelock` plugin **does not require any special _permissions_** on any platform :) |
| 26 | +This is because it only enables the _screen wakelock_ and not any partial (CPU) wakelocks that would keep the app alive in the background. | ||
| 18 | 27 | ||
| 19 | ### Implementation | 28 | ### Implementation |
| 20 | 29 | ||
| 21 | Everything in this plugin is controlled via the [`Wakelock` class](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock-class.html). | 30 | Everything in this plugin is controlled via the [`Wakelock` class](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock-class.html). |
| 22 | -If you want to enable the wakelock, i.e. keep the device awake, you can simply call [`Wakelock.enable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/enable.html) | 31 | +If you want to enable the wakelock, i.e. keep the device awake, you can simply call [`Wakelock.enable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/enable.html) |
| 23 | and to disable it again, you can use [`Wakelock.disable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/disable.html): | 32 | and to disable it again, you can use [`Wakelock.disable`](https://pub.dev/documentation/wakelock/latest/wakelock/Wakelock/disable.html): |
| 24 | 33 | ||
| 25 | ```dart | 34 | ```dart |
| @@ -2,7 +2,7 @@ name: wakelock | @@ -2,7 +2,7 @@ name: wakelock | ||
| 2 | description: >-2 | 2 | description: >-2 |
| 3 | Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on | 3 | Plugin that allows you to keep the device screen awake, i.e. prevent the screen from sleeping on |
| 4 | Android, iOS, and web. | 4 | Android, iOS, and web. |
| 5 | -version: 0.3.0-nullsafety.2 | 5 | +version: 0.3.0-nullsafety.3 |
| 6 | homepage: https://github.com/creativecreatorormaybenot/wakelock/tree/master/wakelock | 6 | homepage: https://github.com/creativecreatorormaybenot/wakelock/tree/master/wakelock |
| 7 | 7 | ||
| 8 | environment: | 8 | environment: |
-
Please register or login to post a comment