docs(README): Add gif

This commit is contained in:
Dominik Ferber
2015-10-05 09:18:28 +02:00
parent e7b941d62e
commit ed8e726146
3 changed files with 11 additions and 8 deletions

View File

@@ -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).

View File

@@ -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/)

BIN
docs/media/pub.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 889 KiB