[nongnu] elpa/rust-mode a436945 294/486: Merge pull request #172 from nokaa/master

[ELPA Syncer]

branch: elpa/rust-mode
commit a436945f788e153474c0ec149a565993804fc6a5
Merge: 19e6f60 7f7b2ac
Author: Niko Matsakis <niko@alum.mit.edu>
Commit: GitHub <noreply@github.com>

    Merge pull request #172 from nokaa/master
    
    Add info to enable rustfmt
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 1c21792..7635c39 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@
 `rust-mode` makes editing [Rust](http://rust-lang.org) code with Emacs
 enjoyable.  `rust-mode` requires Emacs 24 or later.
 
+## Installation
+
 ### Manual Installation
 
 To install manually, check out this repository and add this to your
@@ -74,6 +76,18 @@ The file `rust-mode-tests.el` contains tests that can be run 
via
 You can use `run_rust_emacs_tests.sh` to run them in batch mode, if
 you set the environment variable EMACS to a program that runs emacs.
 
+## Features
+
+### Formatting with [rustfmt][rfmt]
+
+The `rust-format-buffer` function will format your code with
+[rustfmt][rfmt] if installed. By default, this is bound to `C-c C-f`.
+
+Placing `(setq rust-format-on-save t)` in your `~/.emacs` will enable automatic
+running of `rust-format-buffer` when you save a buffer.
+
+[rfmt]: https://crates.io/crates/rustfmt/
+
 ## License
 
 `rust-mode` is distributed under the terms of both the MIT license and the