Skip to content

Commit

Permalink
make the npm README look nicer
Browse files Browse the repository at this point in the history
  • Loading branch information
evancz committed Nov 1, 2023
1 parent 8e4a235 commit 2f6dd29
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions installers/npm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]` 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.


<br/>
Expand Down

0 comments on commit 2f6dd29

Please sign in to comment.