diff --git a/README.md b/README.md index 250cf46..85e3c88 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ This repository is the NPM package for ESLINT configuration of IO-Projects TypeS ## Installation +Add the registery to your `.npmrc` file: + +```bash +@ioprojects:registry=https://git.endmove.eu/api/packages/IO-ProjectsOfficial/npm/ +``` + +Install the package: + ```bash # with yarn yarn add -D @io-projects/eslint-config @@ -11,3 +19,35 @@ yarn add -D @io-projects/eslint-config # with npm npm install --save-dev @io-projects/eslint-config ``` + +## Usage + +Add the following to your `.eslintrc.js` file: + +```js +module.exports = { + extends: [ + '@io-projects/eslint-config' + ] +} +``` + +**Or** + +Add the following to your `.eslintrc.json` file: + +```json +{ + "extends": [ + "@io-projects/eslint-config" + ] +} +``` + +**Or** + +Add the following to your `.eslintrc.cjs` file: + +```js +module.exports = require('@ioprojects/ui-eslint-base'); +``` diff --git a/package-lock.json b/package-lock.json index e3e432f..8b7ba1a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@ioprojects/ui-eslint-base", + "name": "@ioprojects/eslint-config", "version": "1.0.4", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@ioprojects/ui-eslint-base", + "name": "@ioprojects/eslint-config", "version": "1.0.4", "license": "SEE LICENSE FILE", "dependencies": { diff --git a/package.json b/package.json index f005ffe..f602a10 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@endmove/eslint-config", + "name": "@ioprojects/eslint-config", "version": "1.0.4", "description": "NPM package for ESLINT configuration of IO-Projects TypeScript front-end projects", "author": "IO-Projects ",