Skip to content

Commit 3f4f772

Browse files
committed
Update readme
1 parent 31b44df commit 3f4f772

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

README.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,53 @@
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. The Lamdera platform is a paid service with a free tier to try, and is how we keep our work funded and sustainable.
8+
9+
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/).
810

911

1012
<br>
1113

12-
## Install
14+
## Installation
15+
16+
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.
17+
18+
To uninstall, simply delete the `lamdera` binary.
19+
20+
## Usage
21+
22+
All `elm` commands work in Lamdera, except:
23+
24+
- `reactor` which is replaced with `live`
25+
- `publish` / `bump` / `diff` are removed, continue to use `elm` for Elm package publishing
26+
27+
See [differences](https://dashboard.lamdera.app/docs/differences) for more info.
1328

14-
[Install](https://guide.elm-lang.org/install/elm.html)
1529

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

1839
<br>
1940

41+
## Development
42+
43+
Interested in contributing? See [extra/readme.md](extra/readme.md).
44+
2045
## Help
2146

22-
If you are stuck, ask around on [the Elm slack channel][slack]. Folks are friendly and happy to help with questions!
47+
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!
48+
49+
For Lamdera compiler/platform discussion, see the [Lamdera Discord](https://dashboard.lamdera.app/docs/discuss).
50+
51+
## Support
2352

24-
[slack]: http://elmlang.herokuapp.com/
53+
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)