You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/19 03:02:07 UTC
git commit: CB-5658 Add doc.index.md for Vibration plugin
Updated Branches:
refs/heads/dev c61cbdfa4 -> 330d35685
CB-5658 Add doc.index.md for Vibration plugin
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/commit/330d3568
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/tree/330d3568
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/diff/330d3568
Branch: refs/heads/dev
Commit: 330d35685ae3e8b05134976799119611b82a3770
Parents: c61cbdf
Author: Andrew Grieve <ag...@chromium.org>
Authored: Wed Dec 18 21:01:54 2013 -0500
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Wed Dec 18 21:01:54 2013 -0500
----------------------------------------------------------------------
README.md | 25 +++++++++++++++++++++----
doc/index.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 77 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/blob/330d3568/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index cbf4c9a..009bedf 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,22 @@
-cordova-plugin-vibration
----------------------------
-To install this plugin, follow the [Command-line Interface Guide](http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface).
+<!---
+ license: 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
-If you are not using the Cordova Command-line Interface, follow [Using Plugman to Manage Plugins](http://cordova.apache.org/docs/en/edge/plugin_ref_plugman.md.html).
+ 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.vibration
+
+Plugin documentation: [doc/index.md](doc/index.md)
http://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration/blob/330d3568/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..0a54e8f
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,56 @@
+<!---
+ license: 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.vibration
+
+This plugin provides a way to vibrate the device.
+
+## Installation
+
+ cordova plugin add org.apache.cordova.vibration
+
+## Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- iOS
+- Windows Phone 7 and 8
+
+## notification.vibrate
+
+Vibrates the device for the specified amount of time.
+
+ navigator.notification.vibrate(time)
+
+- __time__: Milliseconds to vibrate the device. _(Number)_
+
+
+## Example
+
+ // Vibrate for 2.5 seconds
+ navigator.notification.vibrate(2500);
+
+
+## iOS Quirks
+
+- __time__: Ignores the specified time and vibrates for a pre-set amount of time.
+
+ navigator.notification.vibrate();
+ navigator.notification.vibrate(2500); // 2500 is ignored