Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manusant authored Apr 10, 2024
1 parent 673987c commit 421d0f4
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,27 @@ runIt(() => {
[![ESLint](https://img.shields.io/badge/ESLint_Config-eslint--config--katxupa-blue?logo=eslint&logoColor=white)](https://github.com/manusant/eslint-config-katxupa)
[![Linkedin](https://img.shields.io/badge/Linkedin-Manuel--Santos-blue?logo=linkedin&logoColor=white)](https://www.linkedin.com/in/manuel-brito-dos-santos-a7a20a6b/)
[![TSDoc](https://img.shields.io/badge/TypeScript_Doc-blue?logo=typescript&logoColor=white)](https://manusant.github.io/Katxupa)

## Project Configuration
1. Add [Katxupa](https://github.com/manusant/Katxupa) library to project dependencies
```shell
npm install katxupa
pnpm add katxupa
yarn add katxupa
```
2. Add [eslint-config-katxupa](https://github.com/manusant/eslint-config-katxupa) ESLint configs
```shell
npm install --save-dev eslint-config-katxupa
pnpm add --save-dev eslint-config-katxupa
yarn add --dev eslint-config-katxupa
```
3. Activate ESLint config
```js
// .eslintrc.js
module.exports = {
root: true,
env: {node: true},
extends: ["eslint:recommended", "katxupa"],
...
};
```

0 comments on commit 421d0f4

Please sign in to comment.