Skip to content

Commit 2f6dd29

Browse files
committed
make the npm README look nicer
1 parent 8e4a235 commit 2f6dd29

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

installers/npm/README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,20 @@ Head over to [The Official Guide](https://guide.elm-lang.org/) to start learning
99

1010
## What is this package for?
1111

12-
**Normal installs**
12+
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:
1313

14-
Use the instructions [here](https://guide.elm-lang.org/install/elm.html) instead.
15-
16-
**Multiple versions**
14+
**Multiple versions**
1715

1816
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.
1917

20-
**Continuous integration** ⚠️
18+
**Continuous integration**
2119

22-
This works, but there are usually faster and more reliable options:
20+
The `npm` installer works for this, but there are faster and more reliable options:
2321

24-
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.
25-
2. Many continuous integration have ways to cache files ([example](https://docs.travis-ci.com/user/caching/)) to make builds faster and more reliable.
22+
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.
23+
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.
2624

27-
That said, it will definitely work to use the `npm` installer on CI if you prefer that option.
25+
That said, it works to use the `npm` installer on CI if you prefer that option.
2826

2927

3028
<br/>

0 commit comments

Comments
 (0)