diff --git a/README.md b/README.md index 35f3c218..aeee6209 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,15 @@ - ⚡️ Next.js 12 - ⚛️ React 18 - ⛑ TypeScript -- 📏 ESLint — Find and fix problems in your code +- 📏 ESLint — To find and fix problems in your code - 💖 Prettier — Code Formatter for consistent style - 🐶 Husky — For running scripts before committing - 📄 Commitizen — To define a standard way of committing rules -- 🚓 Commitlint — Make sure your commit messages follow the convention -- 🖌 Renovate — Keep your dependencies up to date -- 🚫 lint-staged — To run ESLint and Prettier against staged Git files -- 👷 PR Workflow — Run Type Check & Linters on all Pull Requests -- ⚙️ EditorConfig - Maintain consistent coding styles across editors and IDEs +- 🚓 Commitlint — To make sure your commit messages follow the convention +- 🖌 Renovate — To keep your dependencies up to date +- 🚫 lint-staged — Run ESLint and Prettier against staged Git files +- 👷 PR Workflow — Run Type Check & Linters on Pull Requests +- ⚙️ EditorConfig - Consistent coding styles across editors and IDEs - 🗂 Path Mapping — Import components or images using the `@` prefix ## Quick Start @@ -119,7 +119,7 @@ import avatar from '@/public/avatar.png'; ### Switch to npm -By default, this starter uses Yarn 1 (Classic), but this choice is yours. If you'd like to switch to npm, delete the `yarn.lock` file, install the dependencies with `npm install`, and change the CI workflows, Husky Git hooks, and lint-staged steps to use npm commands. +This starter uses Yarn 1 (Classic) by default, but this choice is yours. If you'd like to switch to npm, delete the `yarn.lock` file, install the dependencies with `npm i`, change the CI workflow, and Husky Git hooks to use npm commands. ## License