Skip to content

Commit

Permalink
docs(README): add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Mar 25, 2021
1 parent dd3888a commit 5dc0ba3
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 4 deletions.
36 changes: 33 additions & 3 deletions README.md
@@ -1,3 +1,18 @@
<div align="center">
<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px">
</div>

<br />

<div align="center">

[![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]

</div>

<br />


# Eslint plugin AdonisJS
> Eslint plugin for AdonisJS applications and packages.
Expand All @@ -7,17 +22,17 @@ This repo contains the config for eslint used by the core packages of AdonisJS a

You'll first need to install [ESLint](http://eslint.org):

```
```sh
$ npm i eslint --save-dev
```

Next, install `eslint-plugin-adonis`:

```
```sh
$ npm install eslint-plugin-adonis --save-dev
```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-adonis` globally.
> **Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-adonis` globally.
## Usage
Add `adonis` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
Expand All @@ -43,3 +58,18 @@ Add `adonis` to the plugins section of your `.eslintrc` configuration file. You
]
}
```

<div align="center">
<sub>Built with ❤︎ by <a href="https://github.com/thetutlage">Harminder Virk</a>
</div>

[npm-image]: https://img.shields.io/npm/v/eslint-plugin-adonis/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/eslint-plugin-adonis/v/alpha "npm"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript

[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs-community/eslint-plugin-adonis?style=for-the-badge

[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs-community/eslint-plugin-adonis?label=Synk%20Vulnerabilities&style=for-the-badge
[synk-url]: https://snyk.io/test/github/adonisjs-community/eslint-plugin-adonis?targetFile=package.json "synk"
2 changes: 1 addition & 1 deletion package.json
@@ -1,7 +1,7 @@
{
"name": "eslint-plugin-adonis",
"version": "1.3.0",
"description": "Eslint rules for AdonisJs applications and addons",
"description": "ESlint rules for AdonisJs applications and addons",
"keywords": [
"eslint",
"eslintplugin",
Expand Down

0 comments on commit 5dc0ba3

Please sign in to comment.