Skip to content

Commit 12fcc1b

Browse files
committed
Update README.md
1 parent 212aec2 commit 12fcc1b

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
## ElixirScript [![Documentation](https://img.shields.io/badge/docs-hexpm-blue.svg)](http://hexdocs.pm/elixir_script/) [![Build](https://travis-ci.org/elixirscript/elixirscript.svg?branch=master)](https://travis-ci.org/elixirscript/elixirscript) [![Deps Status](https://beta.hexfaktor.org/badge/all/github/bryanjos/elixirscript.svg)](https://beta.hexfaktor.org/github/bryanjos/elixirscript) [![Join the chat at https://gitter.im/elixirscript/elixirscript](https://badges.gitter.im/elixirscript/elixirscript.svg)](https://gitter.im/elixirscript/elixirscript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1+
## ElixirScript [![Documentation](https://img.shields.io/badge/docs-hexpm-blue.svg)](http://hexdocs.pm/elixir_script/) [![Build](https://travis-ci.org/elixirscript/elixirscript.svg?branch=master)](https://travis-ci.org/elixirscript/elixirscript)
22

33
The goal is to convert a subset (or full set) of Elixir code to JavaScript, providing the ability to write JavaScript in Elixir. This is done by taking the Elixir AST and converting it into JavaScript AST and then to JavaScript code. This is done using the [Elixir-ESTree](https://github.com/elixirscript/elixir-estree) library.
44

55
[Documentation for current release](http://hexdocs.pm/elixir_script/)
66

7-
Requirements
8-
===========
7+
# Requirements
8+
99
* Erlang 20 or greater
10-
* Elixir 1.5 or greater (must be compiled with Erlang 20 or greater)
10+
* Elixir 1.6 or greater (must be compiled with Erlang 20 or greater)
1111
* Node 8.2.1 or greater (only for development)
1212

13-
Usage
14-
========
13+
# Usage
1514

1615
Add dependency to your deps in mix.exs:
1716

18-
``` elixir
17+
```elixir
1918
{:elixir_script, "~> x.x"}
2019
```
2120

@@ -42,18 +41,17 @@ Also add `elixir_script` configuration
4241

4342
Run `mix compile`
4443

45-
46-
Examples
47-
==========
44+
# Examples
4845

4946
### Application
47+
5048
[ElixirScript Todo Example](https://github.com/elixirscript/todo-elixirscript)
5149

5250
### Library
51+
5352
[ElixirScript React](https://github.com/elixirscript/elixirscript_react)
5453

55-
Development
56-
===========
54+
# Development
5755

5856
```bash
5957
# Clone the repo
@@ -69,14 +67,10 @@ make
6967
make test
7068
```
7169

72-
Communication
73-
========
74-
75-
[gitter room](https://gitter.im/elixirscript/elixirscript)
70+
# Communication
7671

7772
[#elixirscript](https://elixir-lang.slack.com/messages/elixirscript/) on the elixir-lang Slack
7873

79-
Contributing
80-
========
74+
# Contributing
8175

8276
Please check the [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)