From 3f4f772f1edcd5f143dd0d63feff6ff21598dce7 Mon Sep 17 00:00:00 2001 From: Mario Rogic Date: Thu, 26 Dec 2024 09:33:28 +1000 Subject: [PATCH] Update readme --- README.md | 47 ++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 38 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 79715a6e..723e5be5 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,53 @@ -For Lamdera docs, see [extra/readme.md](extra/readme.md). +# Lamdera Elm Compiler -# Elm +Elm is [a delightful language for reliable webapps](https://elm-lang.org/). -A delightful language for reliable webapps. +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). -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/) +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. + +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/).
-## Install +## Installation + +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. + +To uninstall, simply delete the `lamdera` binary. + +## Usage + +All `elm` commands work in Lamdera, except: + +- `reactor` which is replaced with `live` +- `publish` / `bump` / `diff` are removed, continue to use `elm` for Elm package publishing + +See [differences](https://dashboard.lamdera.app/docs/differences) for more info. -✨ [Install](https://guide.elm-lang.org/install/elm.html) ✨ -For multiple versions, previous versions, and uninstallation, see the instructions [here](https://github.com/elm/compiler/blob/master/installers/README.md). +## Getting started + +```bash +lamdera init +lamdera live +``` + +See the [Lamdera overview](https://dashboard.lamdera.app/docs/overview) for more.
+## Development + +Interested in contributing? See [extra/readme.md](extra/readme.md). + ## Help -If you are stuck, ask around on [the Elm slack channel][slack]. Folks are friendly and happy to help with questions! +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! + +For Lamdera compiler/platform discussion, see the [Lamdera Discord](https://dashboard.lamdera.app/docs/discuss). + +## Support -[slack]: http://elmlang.herokuapp.com/ +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).