diff --git a/README.md b/README.md index 43560fc2d6..57bd20a09b 100755 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ ESLint-plugin-Meteor Meteor specific linting rules for ESLint +![Example](docs/media/pub.gif) +*This gif shows integration of ESLint-plugin-Meteor into Atom with [linter](https://atom.io/packages/linter) and [linter-eslint](https://atom.io/packages/linter-eslint). Find out more in the [setup guide](docs/SETUP_DEVELOPMENT.md).* + + # Installation Install [ESLint](https://www.github.com/eslint/eslint) either locally or globally. @@ -70,17 +74,10 @@ For a more thorough introduction, read [setting up a Meteor project](docs/SETUP_ [Any rule idea is welcome !](https://github.com/dferber90/eslint-plugin-meteor/issues) -## Contributing +# Contributing Read about [set up of the development environment](docs/SETUP_DEVELOPMENT.md). -## Essential Development Resources - -These specs and tools help enormously when developing new rules. -* [ESTree Spec](https://github.com/estree/estree/blob/master/spec.md) -* [Espree Parser](http://eslint.org/parser/) - - # Thanks This plugin is inspired by [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react). diff --git a/docs/SETUP_DEVELOPMENT.md b/docs/SETUP_DEVELOPMENT.md index 0619d0f479..4a7f22b241 100644 --- a/docs/SETUP_DEVELOPMENT.md +++ b/docs/SETUP_DEVELOPMENT.md @@ -63,3 +63,9 @@ Rules defined in this plugin differ from regular ESLint rules. Meteor treats fil ## Give back After making sure all tests pass and the test-coverage is at 100%, please send a PR to [dferber90/eslint-plugin-meteor](https://github.com/dferber90/eslint-plugin-meteor). + +## Essential Development Resources + +These specs and tools help enormously when developing new rules. +* [ESTree Spec](https://github.com/estree/estree/blob/master/spec.md) +* [Espree Parser](http://eslint.org/parser/) diff --git a/docs/media/pub.gif b/docs/media/pub.gif new file mode 100644 index 0000000000..7506e5758e Binary files /dev/null and b/docs/media/pub.gif differ