From 00cc851a9185e809e9ca37731e2d8be173b7d3d0 Mon Sep 17 00:00:00 2001 From: Michael Foss Date: Wed, 6 Feb 2019 14:21:14 -0500 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3552e99c0..f5932178c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## :book: Documentation -See https://eslint.vuejs.org +See [the official website](https://eslint.vuejs.org). ## :anchor: Versioning Policy @@ -17,37 +17,37 @@ This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint' ## :newspaper: Changelog -We're using [GitHub Releases](https://github.com/vuejs/eslint-plugin-vue/releases). +This project uses [GitHub Releases](https://github.com/vuejs/eslint-plugin-vue/releases). -## :beers: Contribution guide +## :beers: Contribution Guide -Contributing is welcome! +Contribution is welcome! -See https://eslint.vuejs.org/developer-guide/ +See [The ESLint Vue Plugin Developer Guide](https://eslint.vuejs.org/developer-guide/). -### Working with rules +### Working with Rules -Before you start writing new rule, please read the [official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules). +Before you start writing a new rule, please read [the official ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules). -Next in order to get an idea how does the AST of the code that you want to check looks like, you can use one of the following applications: -- [astexplorer.net](https://astexplorer.net/) - best tool to inspect ASTs, but it doesn't support Vue templates yet -- [ast.js.org](https://ast.js.org/) - not fully featured, but supports Vue templates syntax +Next, in order to get an idea how does the AST of the code that you want to check looks like, use one of the following applications: +- [astexplorer.net](https://astexplorer.net/) - the best tool to inspect ASTs, but it doesn't support Vue template yet +- [ast.js.org](https://ast.js.org/) - not fully featured, but supports Vue template syntax -Since single file components in Vue are not plain JavaScript, we can't use the default parser, and we had to introduce additional one: `vue-eslint-parser`, that generates enhanced AST with nodes that represent specific parts of the template syntax, as well as what's inside the `