]> code.delx.au - gnu-emacs-elpa/blobdiff - README.md
Parse generator methods better
[gnu-emacs-elpa] / README.md
index d66c69a906f2951c7d42340cc8882371d62e4498..cbce9c37c376c9499715501f781c5b37c611f7bf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,36 +1,50 @@
-Description
+About [![Build Status](https://travis-ci.org/mooz/js2-mode.svg?branch=master)](https://travis-ci.org/mooz/js2-mode) [![MELPA](https://melpa.org/packages/js2-mode-badge.svg)](https://melpa.org/#/js2-mode)
 ======
 
-An improved JavaScript mode for GNU Emacs. Forked from <http://code.google.com/p/js2-mode/>.
+Improved JavaScript editing mode for GNU Emacs ([description here](http://elpa.gnu.org/packages/js2-mode.html)).
 
 For some of the latest changes, see [latest user-visible changes](https://github.com/mooz/js2-mode/wiki/Latest-user-visible-changes).
 
 Installation
 ======
 
-    $ git clone git://github.com/mooz/js2-mode.git
-    $ cd js2-mode
-    $ emacs --batch -f batch-byte-compile js2-mode.el
+The stable versions are hosted at [GNU ELPA](http://elpa.gnu.org/)
+(<kbd>M-x list-packages</kbd>).
 
-Then put js2-mode.elc into your site-lisp directory.
-
-In your 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
-additional details.
+You can also install the latest development version from
+[MELPA](https://melpa.org/#/getting-started).
 
 Emacs 22 and 23
 ===============
 
-This version requires Emacs 24. For a backward compatible version, check out the branch [emacs23](https://github.com/mooz/js2-mode/tree/emacs23).
+This version requires Emacs 24 and `cl-lib` (either built-in or from GNU ELPA above).
+For a backward compatible version, check out the branch
+[emacs23](https://github.com/mooz/js2-mode/tree/emacs23).
 
 Bugs
 ====
 
-If you find problems, please report them at <http://github.com/mooz/js2-mode/issues>.
+* See broken syntax highlighting and timer errors? Recently upgraded
+Emacs from version 24.2 or earlier?
+
+* Try
+[reinstalling or byte-recompiling](https://github.com/mooz/js2-mode/issues/72)
+the package.
+
+Please report problems at <http://github.com/mooz/js2-mode/issues>.
+
+Contributing
+======
+
+`js2-mode` is subject to the same
+[copyright assignment](http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html)
+policy as Emacs itself, `org-mode`, `CEDET` and other packages in
+[GNU ELPA](http://elpa.gnu.org/packages/).
+
+Any
+[legally significant](http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant)
+contributions can only be accepted after the author has completed their
+paperwork. Please ask for the request form, and we'll send it to you.
 
 See Also
 ======