Skip to content

Commit 7b19439

Browse files
committed
Update readme
1 parent 31b44df commit 7b19439

File tree

1 file changed

+40
-9
lines changed

1 file changed

+40
-9
lines changed

README.md

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,55 @@
1-
For Lamdera docs, see [extra/readme.md](extra/readme.md).
1+
# Lamdera Elm Compiler
22

3-
# Elm
3+
Elm is [a delightful language for reliable webapps](https://elm-lang.org/).
44

5-
A delightful language for reliable webapps.
5+
The Lamdera compiler extends the official Elm compiler with tooling that works for any regular Elm frontend project, as well as specific features for Elm projects on [Lamdera: A delightful platform for full-stack Elm web apps](https://lamdera.com).
66

7-
Check out the [Home Page](http://elm-lang.org/), [Try Online](http://elm-lang.org/try), or [The Official Guide](http://guide.elm-lang.org/)
7+
The Lamdera **compiler** is free, open-source and open-contribution [un-fork of the Elm compiler](https://dashboard.lamdera.app/releases/open-source-compiler).
8+
9+
The Lamdera **platform** is a paid service with a free tier to try, and is how we keep our work funded and sustainable.
10+
11+
New to Elm? Check out the [Home Page](http://elm-lang.org/), [Try Online](http://elm-lang.org/try), or [The Official Guide](http://guide.elm-lang.org/).
812

913

1014
<br>
1115

12-
## Install
16+
## Installation
17+
18+
See [Lamdera downloads](https://dashboard.lamdera.app/docs/download) for binary and nix installations (recommended). Or if you have node, `npx lamdera` lets you try it out quickly.
19+
20+
To uninstall, simply delete the `lamdera` binary.
21+
22+
## Usage
23+
24+
All `elm` commands work in Lamdera, except:
25+
26+
- `reactor` which is replaced with `live`
27+
- `publish` / `bump` / `diff` are removed, continue to use `elm` for Elm package publishing
1328

14-
[Install](https://guide.elm-lang.org/install/elm.html)
29+
See [differences](https://dashboard.lamdera.app/docs/differences) for more info.
1530

16-
For multiple versions, previous versions, and uninstallation, see the instructions [here](https://github.com/elm/compiler/blob/master/installers/README.md).
31+
32+
## Getting started
33+
34+
```bash
35+
lamdera init
36+
lamdera live
37+
```
38+
39+
See the [Lamdera overview](https://dashboard.lamdera.app/docs/overview) for more.
1740

1841
<br>
1942

43+
## Development
44+
45+
Interested in contributing? See [extra/readme.md](extra/readme.md).
46+
2047
## Help
2148

22-
If you are stuck, ask around on [the Elm slack channel][slack]. Folks are friendly and happy to help with questions!
49+
If you are stuck with Elm, ask around on [the Elm slack channel](http://elmlang.herokuapp.com/). Folks are friendly and happy to help with questions!
50+
51+
For Lamdera compiler/platform discussion, see the [Lamdera Discord](https://dashboard.lamdera.app/docs/discuss).
52+
53+
## Support
2354

24-
[slack]: http://elmlang.herokuapp.com/
55+
You can support the development of the Lamdera compiler with [sponsorship](https://github.com/sponsors/supermario), by [upgrading to a paid Lamdera plan](https://dashboard.lamdera.app/docs/pricing), or by setting [feature bounties (chat with us)](https://dashboard.lamdera.app/docs/discuss).

0 commit comments

Comments
 (0)