You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2015/03/14 00:47:16 UTC
cordova-plugin-battery-status git commit: CB-8653 Updated Readme
Repository: cordova-plugin-battery-status
Updated Branches:
refs/heads/master 50fd63d19 -> c8dc4b93b
CB-8653 Updated Readme
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/commit/c8dc4b93
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/tree/c8dc4b93
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/diff/c8dc4b93
Branch: refs/heads/master
Commit: c8dc4b93b647cb105039d9758991c99213043430
Parents: 50fd63d
Author: Steve Gill <st...@gmail.com>
Authored: Fri Mar 13 16:46:53 2015 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Fri Mar 13 16:47:03 2015 -0700
----------------------------------------------------------------------
README.md | 120 +++++++++++++++++++++++++++++++++++++++++++++-
doc/index.md | 139 ------------------------------------------------------
2 files changed, 118 insertions(+), 141 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/blob/c8dc4b93/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 765b794..829d40d 100644
--- a/README.md
+++ b/README.md
@@ -17,8 +17,124 @@
under the License.
-->
-# org.apache.cordova.battery-status
+# cordova-plugin-battery-status
[](https://travis-ci.org/apache/cordova-plugin-battery-status)
-Plugin documentation: [doc/index.md](doc/index.md)
+This plugin provides an implementation of an old version of the [Battery Status Events API](http://www.w3.org/TR/2011/WD-battery-status-20110915/).
+
+It adds the following three `window` events:
+
+* batterystatus
+* batterycritical
+* batterylow
+
+## Installation
+
+ cordova plugin add cordova-plugin-battery-status
+
+## batterystatus
+
+This event fires when the percentage of battery charge changes by at
+least 1 percent, or if the device is plugged in or unplugged.
+
+The battery status handler is passed an object that contains two
+properties:
+
+- __level__: The percentage of battery charge (0-100). _(Number)_
+
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+Applications typically should use `window.addEventListener` to
+attach an event listener after the `deviceready` event fires.
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Windows Phone 7 and 8
+- Tizen
+- Firefox OS
+
+### Windows Phone 7 and 8 Quirks
+
+Windows Phone 7 does not provide native APIs to determine battery
+level, so the `level` property is unavailable. The `isPlugged`
+parameter _is_ supported.
+
+### Example
+
+ window.addEventListener("batterystatus", onBatteryStatus, false);
+
+ function onBatteryStatus(info) {
+ // Handle the online event
+ console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
+ }
+
+## batterycritical
+
+The event fires when the percentage of battery charge has reached the
+critical battery threshold. The value is device-specific.
+
+The `batterycritical` handler is passed an object that contains two
+properties:
+
+- __level__: The percentage of battery charge (0-100). _(Number)_
+
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+Applications typically should use `window.addEventListener` to attach
+an event listener once the `deviceready` event fires.
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Tizen
+- Firefox OS
+
+### Example
+
+ window.addEventListener("batterycritical", onBatteryCritical, false);
+
+ function onBatteryCritical(info) {
+ // Handle the battery critical event
+ alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
+ }
+
+## batterylow
+
+The event fires when the percentage of battery charge has reached the
+low battery threshold, device-specific value.
+
+The `batterylow` handler is passed an object that contains two
+properties:
+
+- __level__: The percentage of battery charge (0-100). _(Number)_
+
+- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
+
+Applications typically should use `window.addEventListener` to
+attach an event listener once the `deviceready` event fires.
+
+### Supported Platforms
+
+- Amazon Fire OS
+- iOS
+- Android
+- BlackBerry 10
+- Tizen
+- Firefox OS
+
+### Example
+
+ window.addEventListener("batterylow", onBatteryLow, false);
+
+ function onBatteryLow(info) {
+ // Handle the battery low event
+ alert("Battery Level Low " + info.level + "%");
+ }
http://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status/blob/c8dc4b93/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
deleted file mode 100644
index 9ebe5b7..0000000
--- a/doc/index.md
+++ /dev/null
@@ -1,139 +0,0 @@
-<!---
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-# org.apache.cordova.battery-status
-
-This plugin provides an implementation of an old version of the [Battery Status Events API](http://www.w3.org/TR/2011/WD-battery-status-20110915/).
-
-It adds the following three `window` events:
-
-* batterystatus
-* batterycritical
-* batterylow
-
-## Installation
-
- cordova plugin add org.apache.cordova.battery-status
-
-## batterystatus
-
-This event fires when the percentage of battery charge changes by at
-least 1 percent, or if the device is plugged in or unplugged.
-
-The battery status handler is passed an object that contains two
-properties:
-
-- __level__: The percentage of battery charge (0-100). _(Number)_
-
-- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
-
-Applications typically should use `window.addEventListener` to
-attach an event listener after the `deviceready` event fires.
-
-### Supported Platforms
-
-- Amazon Fire OS
-- iOS
-- Android
-- BlackBerry 10
-- Windows Phone 7 and 8
-- Tizen
-- Firefox OS
-
-### Windows Phone 7 and 8 Quirks
-
-Windows Phone 7 does not provide native APIs to determine battery
-level, so the `level` property is unavailable. The `isPlugged`
-parameter _is_ supported.
-
-### Example
-
- window.addEventListener("batterystatus", onBatteryStatus, false);
-
- function onBatteryStatus(info) {
- // Handle the online event
- console.log("Level: " + info.level + " isPlugged: " + info.isPlugged);
- }
-
-## batterycritical
-
-The event fires when the percentage of battery charge has reached the
-critical battery threshold. The value is device-specific.
-
-The `batterycritical` handler is passed an object that contains two
-properties:
-
-- __level__: The percentage of battery charge (0-100). _(Number)_
-
-- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
-
-Applications typically should use `window.addEventListener` to attach
-an event listener once the `deviceready` event fires.
-
-### Supported Platforms
-
-- Amazon Fire OS
-- iOS
-- Android
-- BlackBerry 10
-- Tizen
-- Firefox OS
-
-### Example
-
- window.addEventListener("batterycritical", onBatteryCritical, false);
-
- function onBatteryCritical(info) {
- // Handle the battery critical event
- alert("Battery Level Critical " + info.level + "%\nRecharge Soon!");
- }
-
-## batterylow
-
-The event fires when the percentage of battery charge has reached the
-low battery threshold, device-specific value.
-
-The `batterylow` handler is passed an object that contains two
-properties:
-
-- __level__: The percentage of battery charge (0-100). _(Number)_
-
-- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_
-
-Applications typically should use `window.addEventListener` to
-attach an event listener once the `deviceready` event fires.
-
-### Supported Platforms
-
-- Amazon Fire OS
-- iOS
-- Android
-- BlackBerry 10
-- Tizen
-- Firefox OS
-
-### Example
-
- window.addEventListener("batterylow", onBatteryLow, false);
-
- function onBatteryLow(info) {
- // Handle the battery low event
- alert("Battery Level Low " + info.level + "%");
- }
-
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org