X-Git-Url: https://git.yukkurigames.com/?p=enjoyable.git;a=blobdiff_plain;f=README.md;h=22ed9c688bb6347782607966313331c5ac189c35;hp=b6ccd6c9addb12e43eaeca9f9bf6d7142073c462;hb=4dabc5c754efa54adb2dc57063c7294b1c2e4654;hpb=5f07baa8cb03a2f6aa06338bfeb31dad3c3ca29f

diff --git a/README.md b/README.md
index b6ccd6c..22ed9c6 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,59 @@
-enjoy2
-======
+Enjoyable
+=========
 
-Transform joystick input into keyboard and mouse events (OSX)
\ No newline at end of file
+Enjoyable is an application for Mac OS X which allows you to use
+controller inputs like a mouse or keyboard. If you've ever played a
+video game which only supports mouse and keyboard input but you want
+to use a joystick or gamepad, then Enjoyable is the program for you.
+
+Enjoyable supports
+
+ * Mapping gamepad and joystick buttons to keyboard and mouse actions
+ * Fine control over mouse movement and scrolling using analog axis
+   inputs
+ * Automatic and dynamic switching between different input mappings
+ * Downloading and sharing input presets for different applications
+ * Modern OS X features like resume and automatic termination
+
+Enjoyable is free software written by Joe Wreschnig and is based on
+the Enjoy codebase written by [Yifeng Huang](http://nongraphical.com)
+and [Sam McCall](http://abstractable.net/enjoy/).
+
+## How to Use
+
+To start, just press a button on your joystick or gamepad, then press
+the key you want to map it for. Then press the ▶ button and switch
+back to your game. For more details, Enjoyable has a in-application
+manual available in Help Viewer via `⌘?`.
+
+## Requirements
+
+* Mac OS X 10.7+
+* One or more HID-compatible (e.g. USB or Bluetooth) input devices
+
+## License
+
+Copyright 2013 Joe Wreschnig  
+          2012 Yifeng Huang  
+          2009 Sam McCall, University of Otago
+
+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.
+
+The joystick icon is from the Tango icon set and is public domain.