Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jbmaisner committed Apr 7, 2023
1 parent c622dcc commit f40aaac
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,26 @@
# eslint-plugin-orion
🔩 An ESLint plugin to use with eslint-config-orion

⚙️ An ESLint plugin for better consistency across projects

This plugin add some global rules and also new rules for async function naming convention.

> It is based on the [eslint-plugin-async-protect](https://github.com/IPWright83/eslint-plugin-async-protect).
## Installation

```sh
npm i -D @orion.ui/eslint-plugin-orion
```

Then add it in your `eslint` config file :

```js
module.exports = {
...
extends: [
...
'plugin:@orion.ui/orion/recommended',
],
...
};
```

0 comments on commit f40aaac

Please sign in to comment.