Permalink
Browse files

Updated readme

Added some examples for usage
  • Loading branch information...
1 parent 7eae299 commit c5efe23372a65ce1c878fad6980796febc528945 @tobias-b tobias-b committed Jan 2, 2014
Showing with 12 additions and 0 deletions.
  1. +12 −0 README.md
View
@@ -2,3 +2,15 @@ PhoneGap-SoftKeyboard
=====================
Android SoftKeyboard Plugin for PhoneGap
+
+Usage
+-----
+
+- `SoftKeyboard.show()` to show the keyboard
+- `SoftKeyboard.hide()` to hide it
+- Keyboard visible callback: `SoftKeyboard.isShowing(function(){ console.log('success'); }, function(){ console.log('fail'); })`
+
+BTW:
+To have callback for hiding and showing the keyboard you can use:
+"showkeyboard" / "hidekeyboard" events wich are not mentioned in the docs.
+

0 comments on commit c5efe23

Please sign in to comment.