Skip to content

Commit 62c4d92

Browse files
committed
Merge pull request #133 from elixir-lang/update-readme
refine readme
2 parents 8c3cdaf + 6eb3fa0 commit 62c4d92

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
1-
# Elixir Mode [![Build Status](https://travis-ci.org/elixir-lang/emacs-elixir.svg?branch=master)](https://travis-ci.org/elixir-lang/emacs-elixir)
1+
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
2+
[![Build Status](https://travis-ci.org/elixir-lang/emacs-elixir.svg?branch=master)](https://travis-ci.org/elixir-lang/emacs-elixir)
3+
[![MELPA](http://melpa.org/packages/elixir-mode-badge.svg)](http://melpa.org/#/elixir-mode)
4+
5+
# Elixir Mode
26

37
Provides font-locking, indentation and navigation support for the
48
[Elixir programming language.](http://elixir-lang.org/)
59

10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Interactive Commands](#interactive-commands)
13+
- [Configuration](#configuration)
14+
- [Hooks](#hooks)
15+
- [Keymapping](#keymapping)
16+
- [Notes](#notes)
17+
- [Elixir Tooling Integration](#elixir-tooling-integration)
18+
- [History](#history)
19+
- [Contributing](#contributing)
20+
621
## Installation
722

823
### ELPA
@@ -12,7 +27,7 @@ elixir-mode is available on the community maintained repository -
1227
[RET] elixir-mode [RET]` inside your emacs and you're ready to go.
1328

1429
**Please take note of the MELPA URL.** If you are using http://melpa.milkbox.net
15-
then you are not getting the latest *stable* version of this package.
30+
then you are not getting the latest *stable* version of this package.
1631
Please use http://melpa-stable.milkbox.net when retrieving this package.
1732

1833
If you're not already using ELPA, check the [emacswiki](http://www.emacswiki.org/emacs/ELPA) page to get
@@ -23,7 +38,7 @@ familiar with it.
2338
If you would prefer to install from source, you can download the latest tagged
2439
release from https://github.com/elixir-lang/emacs-elixir/releases/latest/.
2540

26-
After unzipping either the tarball or zipfile into your desired location,
41+
After unzipping either the tarball or zipfile into your desired location,
2742
add the following in your .emacs file:
2843

2944
```lisp
@@ -180,9 +195,9 @@ experience, you can add the following to your `elixir-mode-hook`:
180195
(ruby-end-mode +1)))
181196
```
182197

183-
## Mix
198+
## Elixir Tooling Integration
184199

185-
If you looking for integrated emacs [mix](http://elixir-lang.org/getting_started/mix/1.html) support, see here: [elixir-mix.el](https://github.com/tonini/elixir-mix.el)
200+
If you looking for elixir tooling integration for emacs, check: [alchemist.el](https://github.com/tonini/alchemist.el)
186201

187202
## History
188203

@@ -192,3 +207,5 @@ This mode is based on the
192207
## Contributing
193208

194209
Please read [CONTRIBUTING.md](https://github.com/elixir-lang/emacs-elixir/blob/master/CONTRIBUTING.md) for guidelines on how to contribute to this project.
210+
211+
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg

0 commit comments

Comments
 (0)