Skip to content

Commit

Permalink
docs(readme): update (#198)
Browse files Browse the repository at this point in the history
Co-authored-by: Nikita Almanov <[email protected]>
  • Loading branch information
github-actions[bot] and nikkeyl committed Feb 1, 2024
1 parent d831873 commit f253f37
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ This template includes ready-made solutions for integration with:
> By default **eslint**, **prettier**, **editorconfig-checker** and
> **remark** check all files in the project, if you want to change this
> behavior then go to [**`package.json`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/package.json)
> and [**`lintstagedrc.json`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.lintstagedrc.json)
> and [**`lint-staged.config.js`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/lint-staged.config.js)
> files.
- **Tests**: Automated testing will help you focus on
Expand Down Expand Up @@ -185,19 +185,19 @@ This template includes ready-made solutions for integration with:

- **`init`**: Installs **`node_modules`** and **`Husky`**.

- **`lint:editorconfig`**: Runs **`Editorconfig Checker`** and
checks all files in the project.

> Also runs with the [**`editorconfig.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/editorconfig.yml)
> workflow.
- **`fix:prettier`**: Runs **`Prettier`** with the **`--write`** flag.

> In the [**`prettier.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/prettier.yml)
> workflow, **`Prettier`** is run with the **`--check`** flag.
>
> Also run with a **`pre-commit`** hook.
- **`lint:editorconfig`**: Runs **`Editorconfig Checker`** and
checks all files in the project.

> Also runs with the [**`editorconfig.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/editorconfig.yml)
> workflow.
- **`lint:markdown`**: Runs **`Remark`** with the **`--quiet`** flag and
checks all markdown files.

Expand All @@ -215,8 +215,8 @@ This template includes ready-made solutions for integration with:
> Also runs using the [**`mocha.yml`**](https://github.com/Conqueror-Site-Builder/conqueror-repo-template/blob/main/.github/workflows/mocha.yml)
> workflow.
- **`cm`**: Runs **`Commitizen`**, **`Commitlint`**, and **`Husky`** to create
commits according to **Conventional Commits** standards.
- **`commit`**: Runs **`Commitizen`**, **`Commitlint`**, and **`Husky`** to
create commits according to **Conventional Commits** standards.

## Workflows

Expand Down Expand Up @@ -280,7 +280,7 @@ Everything you need is already configured in it.
> [**Conqueror Helpers**](https://github.com/Conqueror-Site-Builder/.vscode/settings.json).
> \[!TIP]
> If you want to change the rules in **`.prettierrc.json`** you can do it
> If you want to change the rules in **`prettier.config.js`** you can do it
> in **`.editorconfig`**, prettier will automatically pick up the rules
> from editorconfig.
Expand Down

0 comments on commit f253f37

Please sign in to comment.