Added document

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..553606b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+js2-mode
+========
+
+An improved JavaScript mode for GNU Emacs. Forked from <http://code.google.com/p/js2-mode/>.
+
+Install
+=======
+
+    $ git clone git://github.com/mooz/js2-mode.git
+    $ cd js2-mode
+    $ emacs --batch --eval '(byte-compile-file "js2-mode.el")'
+
+Then, place js2-mode.elc into your site-lisp directory.
+
+In you emacs config:
+
+    (autoload 'js2-mode "js2-mode" nil t)
+    (add-to-list 'auto-mode-alist '("\\.js$" . js2-mode))
+
+See <http://code.google.com/p/js2-mode/wiki/InstallationInstructions> for details.
+
+Differences between original js2-mode.el
+========================================
+
+Support for abbreviated destructuring assignments
+-------------------------------------------------
+
+    let {a, b}       = {a: 10, b: 20}; // Abbreviated   (Not supported in original js2-mode.el)
+    let {a: a, b: b} = {a: 10, b: 20}; // Same as above (Supported in original js2-mode.el)
+
+    (function ({responseText}) { /* */ })(xhr); // As the argument of function
+
+Support for expression closure in property value
+------------------------------------------------
+
+    let worker = {
+        get age() 20,
+        get sex() "male",
+        fire: function () _fire()
+    };
+
+Bugs
+====
+
+If you find problems, please report them to <http://github.com/mooz/js2-mode/issues>.