Permalink
Browse files

Add basic README

  • Loading branch information...
1 parent d79970f commit cae3cef5b9183c16dbb967996423c77125ac3ba5 @purcell committed Nov 17, 2012
Showing with 31 additions and 0 deletions.
  1. +31 −0 README.md
View
@@ -0,0 +1,31 @@
+flymake-jslint.el
+=================
+
+An Emacs flymake handler for syntax-checking Javascript source code
+using [`jslint`](http://jslint.com/).
+
+Installation
+=============
+
+If you choose not to use one of the convenient packages in
+[Melpa][melpa] and [Marmalade][marmalade], you'll need to add the
+directory containing `flymake-jslint.el` to your `load-path`, and then
+`(require 'flymake-jslint)`. You'll also need to install
+[flymake-easy](https://github.com/purcell/flymake-easy).
+
+Usage
+=====
+
+Add the following to your emacs init file:
+
+ (require 'flymake-jslint)
+ (add-hook 'js-mode-hook 'flymake-jslint-load)
+
+[marmalade]: http://marmalade-repo.org
+[melpa]: http://melpa.milkbox.net
+
+<hr>
+
+[![](http://api.coderwall.com/purcell/endorsecount.png)](http://coderwall.com/purcell)
+
+[![](http://www.linkedin.com/img/webpromo/btn_liprofile_blue_80x15.png)](http://uk.linkedin.com/in/stevepurcell)

0 comments on commit cae3cef

Please sign in to comment.