Skip to content

Commit

Permalink
Docs: Remove prerelease README notes (#173)
Browse files Browse the repository at this point in the history
I plan to release v2.0.0 this weekend, so these prerelease-specific
notes can finally be removed from the README!
  • Loading branch information
btmills committed Feb 14, 2021
1 parent 140adf4 commit 53dc0e5
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Expand Up @@ -12,16 +12,14 @@ Lint JS, JSX, TypeScript, and more inside Markdown.
alt="A JS code snippet in a Markdown editor has red squiggly underlines. A tooltip explains the problem."
/>

> 🚧 This documentation is for an unfinished v2 release in progress in the `main` branch. The latest stable documentation is in the [`v1` branch](https://github.com/eslint/eslint-plugin-markdown/tree/v1).
## Usage

### Installing

Install the plugin alongside ESLint v6 or greater:

```sh
npm install --save-dev eslint eslint-plugin-markdown@next
npm install --save-dev eslint eslint-plugin-markdown
```

### Configuring
Expand Down Expand Up @@ -144,7 +142,7 @@ module.exports = {
`eslint-plugin-markdown` v2 uses this new API.

```bash
$ npm install --save-dev eslint@latest eslint-plugin-markdown@next
$ npm install --save-dev eslint@latest eslint-plugin-markdown@latest
```

All of the Markdown file extensions that were previously hard-coded are now fully configurable in `.eslintrc.js`.
Expand Down

0 comments on commit 53dc0e5

Please sign in to comment.