Initial commit

andyearnshaw · Jun 16, 2014 · c74806b · c74806b
commit c74806b
Show file tree

Hide file tree

Showing 6 changed files with 857 additions and 0 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Andy Earnshaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# Key Lime - JavaScript-Based Input Method Editor 
+
+Key Lime is an input method editor written using pure JavaScript.  The library
+is designed for Smart TV applications where the manufacturers' virtual
+keyboards can be awkward use. For example, Samsung's JavaScript IME needs to
+have an instance individually attached to every input element you want to use
+it for, and LG Smart TV's native virtual keyboard is great but there's no way
+to detect when the user closes it.  So, in the spirit of writing less code, Key
+Lime allows you to just add the script and "fuggedaboudit".
+
+## Getting started
+
+Download the JavaScript source and add it to your application's HTML:
+
+    <script src="keylime.min.js"></script>
+
+Alternatively, install with Bower:
+
+    bower install keylime
+
+That's it.  The IME will auto-appear on focus of a writable text input. 
+You can change this to work manually by setting
+
+    keyLime.config.noauto = true;
+
+Then just call `keyLime.show()` or `keyLime.hide()` whenever you need it.
+
+## Roadmap
+
+ - Make it easy to add other languages
+ - Allow certain keys to be disabled for different input types
+ - Add other types of input methods, like numeric only, and perhaps date/time
+ - Add dictionary and suggestions support
+
+## License
+
+Copyright (c) 2014 Andy Earnshaw
+
+This software is licensed under the MIT license. See the LICENSE.txt file accompanying this software for terms of use.
diff --git a/bower.json b/bower.json
@@ -0,0 +1,12 @@
+{
+	"name": "keylime",
+    "version": "0.0.1",
+    "description": "Key Lime is an input method editor written using pure JavaScript.",
+	"main": ["keylime.js", "keylime.min.js"],
+    "keywords": [
+        "keyboard",
+        "ime",
+        "input method editor"
+    ]
+}
+
diff --git a/demo.html b/demo.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Key Lime Demo</title>
+    <script src="keylime.js"></script>
+  </head>
+  <body>
+    <p>This is a demo page.  Focus the following input element and play around with the keyboard.</p>
+    <input type="text">
+  </body>
+</html>