diff --git a/README.md b/README.md new file mode 100644 index 000000000..bae2197ed --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ + +``` +$ git clone https://github.com/jlongster/jscodefmt.git +$ cd jscodefmt +$ npm install -g . +$ jscodefmt file.js +``` + +It's most useful when integrated with your editor, so see `editors` to +for editor support. Currently only Emacs integration exists. + +To integrate in Emacs, add the following code. This will format the +file when saved. + +```elisp +(require 'jscodefmt) +(add-hook 'js-mode-hook + (lambda () + (add-hook 'before-save-hook 'jscodefmt-before-save))) +``` \ No newline at end of file