Skip to content

Commit d4da8a7

Browse files
committed
describe versions and installation
1 parent 8a95706 commit d4da8a7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ An ESLint plugin for Svelte v3 components.
1111

1212
## Installation
1313

14-
This is not published to npm. Install from Git tags. See [the documentation on `npm install`](https://docs.npmjs.com/cli/install) for how to do this.
14+
For now, this is not published to npm. Install from Git tags. See [the documentation on `npm install`](https://docs.npmjs.com/cli/install) for how to do this.
1515

16-
This plugin needs to be able to `require('svelte/compiler')`. It requires Svelte 3.0.0-alpha2 or later.
16+
Untagged releases may depend on unreleased Svelte 3 features. Tagged releases should always work with the specified Svelte version. The latest tagged version requires at least Svelte 3.0.0-alpha2.
1717

1818
## Usage
1919

@@ -24,6 +24,8 @@ plugins:
2424
- svelte3
2525
```
2626
27+
This plugin needs to be able to `require('svelte/compiler')`. If ESLint, this plugin, and Svelte are all installed locally in your project, this should not be a problem.
28+
2729
## Configuration
2830

2931
By default, all `.svelte` files will be linted. You can set the `svelte3/extensions` setting in your `.eslintrc` to an array of file extensions to override this.

0 commit comments

Comments
 (0)