Skip to content

Commit 35b2062

Browse files
committed
Improve install instructions in npm package
The npm package's README explains how to install the npm package. The package isn't too useful, since people will probably want to install the VS Code extension instead. Point them in the right direction by linking to our website's install instructions or the VS Code extension directly.
1 parent 5cfa875 commit 35b2062

File tree

1 file changed

+11
-31
lines changed

1 file changed

+11
-31
lines changed

dist/npm/README.md

Lines changed: 11 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,14 @@ quick-lint-js finds many bugs, including:
1414

1515
## Installing
1616

17-
### Install within project
18-
19-
Install quick-lint-js so anyone can use it when hacking on your project:
20-
21-
# Linux and macOS with npm:
22-
$ npm install quick-lint-js --save-dev --save-exact
23-
$ node_modules/.bin/quick-lint-js --version
24-
25-
# Linux and macOS with yarn:
26-
$ yarn add quick-lint-js --dev --exact
27-
$ node_modules/.bin/quick-lint-js --version
28-
29-
# Windows with npm:
30-
$ npm install quick-lint-js --save-dev --save-exact
31-
$ node_modules\.bin\quick-lint-js.cmd --version
32-
33-
# Windows with yarn:
34-
$ yarn add quick-lint-js --dev --exact
35-
$ node_modules\.bin\quick-lint-js.cmd --version
36-
37-
### Install globally
38-
39-
Install quick-lint-js on your machine for use anywhere:
40-
41-
# Linux and macOS:
42-
$ sudo npm install --global --unsafe-perm quick-lint-js
43-
$ quick-lint-js --version
44-
45-
# Windows:
46-
$ npm install --global quick-lint-js
47-
$ quick-lint-js.cmd --version
17+
quick-lint-js is designed to be used with your JavaScript editor. See the
18+
[install documentation](https://quick-lint-js.com/install/) for all installation
19+
options.
20+
21+
* [Visual Studio
22+
Code](https://marketplace.visualstudio.com/items?itemName=quick-lint.quick-lint-js)
23+
* [VSCodium](https://open-vsx.org/extension/quick-lint/quick-lint-js)
24+
* [Vim](https://quick-lint-js.com/install/vim/)
25+
* [Neovim](https://quick-lint-js.com/install/neovim/)
26+
* [Emacs](https://quick-lint-js.com/install/emacs/)
27+
* [CLI & LSP server](https://quick-lint-js.com/install/cli/npm/)

0 commit comments

Comments
 (0)