@capawesome/capacitor-keep-awake 0.0.1 → 0.1.1

package/README.md

@@ -1,4 +1,4 @@
-# @capawesome/capacitor-keep-awake
+# Capacitor Keep Awake Plugin
 
 Capacitor plugin to keep the screen awake.
 
@@ -19,9 +19,14 @@ Capacitor plugin to keep the screen awake.
 
 Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
 
-## Newsletter
+## Use Cases
 
-Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+The Keep Awake plugin is typically used whenever the screen must stay visible without user interaction, for example:
+
+- **Media playback**: Keep the screen on while users watch videos or follow along with content.
+- **Navigation and tracking**: Prevent the display from turning off during turn-by-turn navigation or workout tracking.
+- **Hands-free reading**: Keep recipes, sheet music, or step-by-step instructions visible while the user's hands are busy.
+- **Dashboards and kiosks**: Display live data or presentations without the screen dimming or sleeping.
 
 ## Compatibility
 
@@ -59,21 +64,51 @@ No configuration required for this plugin.
 
 ## Usage
 
+The following examples show how to keep the screen awake, allow it to sleep again, check whether it is currently kept awake, and check whether the feature is available.
+
+### Keep the screen awake
+
+Prevent the screen from dimming or turning off. The screen is kept awake until `allowSleep(...)` is called or the app is restarted. This only affects your app and is not a system-wide setting:
+
 ```typescript
 import { KeepAwake } from '@capawesome/capacitor-keep-awake';
 
 const keepAwake = async () => {
   await KeepAwake.keepAwake();
 };
+```
+
+### Allow the screen to sleep again
+
+Restore the default screen sleep behavior at any time:
+
+```typescript
+import { KeepAwake } from '@capawesome/capacitor-keep-awake';
 
 const allowSleep = async () => {
   await KeepAwake.allowSleep();
 };
+```
+
+### Check if the screen is kept awake
+
+Read whether the screen is currently kept awake:
+
+```typescript
+import { KeepAwake } from '@capawesome/capacitor-keep-awake';
 
 const isKeptAwake = async () => {
   const { keptAwake } = await KeepAwake.isKeptAwake();
   return keptAwake;
 };
+```
+
+### Check if the feature is available
+
+On the Web, keeping the screen awake depends on whether the browser supports the [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API). On Android and iOS, this always returns `true`:
+
+```typescript
+import { KeepAwake } from '@capawesome/capacitor-keep-awake';
 
 const isAvailable = async () => {
   const { available } = await KeepAwake.isAvailable();
@@ -195,6 +230,46 @@ Keep the following in mind when using this plugin:
 - **State reset**: The screen is only kept awake until `allowSleep(...)` is called or the app is restarted.
 - **Web auto-release**: On the Web, the underlying [Screen Wake Lock](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API) is automatically released by the browser whenever the tab becomes hidden (for example, when the user switches tabs or minimizes the window). The plugin automatically re-acquires the wake lock once the tab becomes visible again, as long as `allowSleep(...)` has not been called in the meantime.
 
+## FAQ
+
+### How is this plugin different from other similar plugins?
+
+It keeps the screen awake on Android, iOS, and the Web from one fully typed API, and lets you check both whether the feature is available and whether the screen is currently kept awake. On the Web it uses the Screen Wake Lock API and automatically re-acquires the lock when a hidden tab becomes visible again, so the behavior stays predictable across platforms. It needs no permissions or configuration and is actively maintained against the latest Capacitor version.
+
+### Which platforms does this plugin support?
+
+The plugin supports Android, iOS and Web. On the Web, it relies on the Screen Wake Lock API, so availability depends on the browser. You can check this at runtime with the `isAvailable()` method, which always returns `true` on Android and iOS.
+
+### Does keeping the screen awake affect other apps?
+
+No, keeping the screen awake only affects your app and is not a system-wide setting. As soon as the user leaves your app, the default screen sleep behavior of the device applies again.
+
+### How long is the screen kept awake?
+
+The screen is kept awake until `allowSleep(...)` is called or the app is restarted. The setting is not persisted across app restarts.
+
+### Why does the screen sleep again on the Web after switching tabs?
+
+On the Web, the browser automatically releases the underlying wake lock whenever the tab becomes hidden, for example when the user switches tabs or minimizes the window. The plugin automatically re-acquires the wake lock once the tab becomes visible again, as long as `allowSleep(...)` has not been called in the meantime. See the [Behavior](#behavior) section for details.
+
+### Do I need any permissions or configuration?
+
+No, the plugin does not require any permissions or configuration on any platform. Simply install it and call `keepAwake()`.
+
+### Can I use this plugin with Ionic, React, Vue or Angular?
+
+Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.
+
+## Related Plugins
+
+- [Screen Brightness](https://capawesome.io/docs/sdks/capacitor/screen-brightness/): Read and control the screen brightness.
+- [Screen Orientation](https://capawesome.io/docs/sdks/capacitor/screen-orientation/): Lock and unlock the screen orientation.
+- [Battery](https://capawesome.io/docs/sdks/capacitor/battery/): Access battery information of the device.
+
+## Newsletter
+
+Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+
 ## Changelog
 
 See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/keep-awake/CHANGELOG.md).

package/android/build.gradle

@@ -30,7 +30,7 @@ android {
     buildTypes {
         release {
             minifyEnabled false
-            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }
     }
     lintOptions {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capawesome/capacitor-keep-awake",
-  "version": "0.0.1",
-  "description": "Capacitor plugin to keep the screen awake.",
+  "version": "0.1.1",
+  "description": "Capacitor plugin to keep the screen awake on Android, iOS, and Web.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -33,11 +33,19 @@
       "url": "https://opencollective.com/capawesome"
     }
   ],
-  "homepage": "https://capawesome.io/docs/plugins/keep-awake/",
+  "homepage": "https://capawesome.io/docs/sdks/capacitor/keep-awake/",
   "keywords": [
     "capacitor",
     "plugin",
-    "native"
+    "native",
+    "capacitor-plugin",
+    "keep awake",
+    "keep screen on",
+    "wake lock",
+    "screen wake lock",
+    "prevent sleep",
+    "screen timeout",
+    "display awake"
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",