Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update readme, license file

  • Loading branch information...
commit 0f41c38557f76f2e81c84f12e57cb6c76646d3f3 1 parent cc45ea2
@kneath authored
Showing with 40 additions and 0 deletions.
  1. +18 −0 LICENSE
  2. +22 −0 README.markdown
View
18 LICENSE
@@ -0,0 +1,18 @@
+Copyright (c) 2008 Kyle Neath
+
+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.
View
22 README.markdown
@@ -0,0 +1,22 @@
+# SelectAutoComplter
+
+SelectAutoComplter is a plugin for MooTools (1.2) that provides a way to create an editable `<select>`. It works by replacing a `<select>` in your document with a text field that uses the Quicksilver filtering algorithm to narrow down results.
+
+The Javascript is 100% unobtrusive and will fall back to a `<select>` tag for users without Javascript enabled.
+
+## How to use
+
+Usage is simple. Just call `new SelectAutoComplter(element)` on any `<select>` tag you would like to replace. Your server will receive the same response as if the `<select>` was not replaced, so no backend work is needed.
+
+See `index.html` for a working example.
+
+## License
+
+License is MIT. See LICENSE file.
+
+## Todo
+
+* Need to refactor the keyboardListener function, it's messy
+* Add a trigger to show the list without typing in the box (similar to clicking the down arrow on a select field)
+* Add in effects to make it smoother
+* Test thoroughly
Please sign in to comment.
Something went wrong with that request. Please try again.