From 2f6dd29258e880dbb7effd57a829a0470d8da48b Mon Sep 17 00:00:00 2001 From: Evan Czaplicki Date: Wed, 1 Nov 2023 16:15:26 +0100 Subject: [PATCH] make the npm README look nicer --- installers/npm/README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/installers/npm/README.md b/installers/npm/README.md index 88e17fd1b..e8337e43e 100644 --- a/installers/npm/README.md +++ b/installers/npm/README.md @@ -9,22 +9,20 @@ Head over to [The Official Guide](https://guide.elm-lang.org/) to start learning ## What is this package for? -**Normal installs** ❌ +For normal installs, I reccomend using the instructions [here](https://guide.elm-lang.org/install/elm.html) instead. This package is only for people who enjoy using `npm` even when it is not necessary, or for people who want to use `npm` for certain scenarios such as: -Use the instructions [here](https://guide.elm-lang.org/install/elm.html) instead. - -**Multiple versions** ✅ +**Multiple versions** People using Elm at work may use different versions of Elm in different projects. They can run `npm install elm@latest-0.19.1` in each project and use the binary at `./node_modules/.bin/elm` for compilation. -**Continuous integration** ⚠️ +**Continuous integration** -This works, but there are usually faster and more reliable options: +The `npm` installer works for this, but there are faster and more reliable options: -1. You can download `elm` directly from GitHub with [this script](https://github.com/elm/compiler/blob/master/installers/linux/README.md). This is all the `npm` installer does, but with extra HTTP requests to `npmjs.com` servers, making it slower and adding more failure points. -2. Many continuous integration have ways to cache files ([example](https://docs.travis-ci.com/user/caching/)) to make builds faster and more reliable. +1. You can download `elm` directly from GitHub with [this script](https://github.com/elm/compiler/blob/master/installers/linux/README.md). This allows you to skip `npm` entirely. +2. Many continuous integration have ways to cache files ([example](https://docs.travis-ci.com/user/caching/)) to make builds faster and more reliable. This is the ideal setup. -That said, it will definitely work to use the `npm` installer on CI if you prefer that option. +That said, it works to use the `npm` installer on CI if you prefer that option.