Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 94 lines (61 sloc) 3.138 kB
5c1ff14 @phlipper intital commit
authored
1 # keyboardjs-rails
2
3 [KeyboardJS](http://robertwhurst.github.com/KeyboardJS/), typed up for Rails 3.0 and up. Sweet!
4
5
6 ## Rails 3.1+
7
8 For Rails 3.1 and greater, the files will be added to the asset pipeline and available for you to use.
9
10 To enable:
11
12 * Add the following line to the file `app/assets/javascripts/application.js` (or other [sprockets](https://github.com/sstephenson/sprockets) manifest):
13
14 ``` javascript
15 //= require keyboardjs
16 ```
17
18
19 ### Installation
20
21 * Add `keyboardjs-rails` to your Gemfile
22 * Run `bundle`
23
24 Enjoy!
25
26
27 ## Rails 3.0
28
29 This gem adds a single generator to Rails 3, `keyboardjs:install`. Running the generator will install the JavaScript file necessary to use KeyboardJS.
30
31 ### Installation
32
33 * Add `keyboardjs-rails` to your Gemfile
34 * Run `bundle`
35 * Invoke the generator: `rails generate keyboardjs:install`
36 * Add the following to your layout or view files:
37
38 ```erb
39 <%= javascript_include_tag "keyboardjs" %>
40 ```
41
42 You're done!
43
44
45 ## Contributing
46
47 1. Fork it
48 2. Create your feature branch (`git checkout -b my-new-feature`)
49 3. Commit your changes (`git commit -am 'Added some feature'`)
50 4. Push to the branch (`git push origin my-new-feature`)
51 5. Create new Pull Request
52
53
54 ## License
55
56 **keyboardjs-rails**
57
58 * Freely distributable and licensed under the [MIT license](http://phlipper.mit-license.org/2012/license.html).
59 * Copyright (c) 2012 Phil Cohen (github@phlippers.net) [![endorse](http://api.coderwall.com/phlipper/endorsecount.png)](http://coderwall.com/phlipper)
60 * http://phlippers.net/
61
62 **KeyboardJS**
63
64 * Licenced under the BSD License
65 * Copyright (c) 2011 Robert Hurst
66 * http://robertwhurst.github.com/KeyboardJS/
67
68 ```
69 Copyright 2011 Robert Hurst. All rights reserved.
70
71 Redistribution and use in source and binary forms, with or without modification, are
72 permitted provided that the following conditions are met:
73
74 1. Redistributions of source code must retain the above copyright notice, this list of
75 conditions and the following disclaimer.
76
77 2. Redistributions in binary form must reproduce the above copyright notice, this list
78 of conditions and the following disclaimer in the documentation and/or other materials
79 provided with the distribution.
80
81 THIS SOFTWARE IS PROVIDED BY ROBERT HURST ''AS IS'' AND ANY EXPRESS OR IMPLIED
82 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
83 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ROBERT HURST OR
84 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
85 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
86 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
87 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
88 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
89 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
90
91 The views and conclusions contained in the software and documentation are those of the
92 authors and should not be interpreted as representing official policies, either expressed
93 or implied, of Robert Hurst.
94 ```
Something went wrong with that request. Please try again.