Skip to content

Commit d0f00fe

Browse files
committed
docs: update README.md
1 parent 6ba59fd commit d0f00fe

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# js-quality-starter
22

3+
[![CI](https://github.com/your-username/your-new-repo/actions/workflows/ci.yml/badge.svg)](https://github.com/your-username/your-new-repo/actions/workflows/ci.yml)
4+
[![codecov](https://codecov.io/gh/your-username/your-new-repo/graph/badge.svg?token=YOUR_CODECOV_TOKEN)](https://codecov.io/gh/your-username/your-new-repo)
5+
[![Code style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
38
A template repository for modern JavaScript projects with pre-configured linting, formatting, testing, and CI/CD using GitHub Actions.
49

510
This template provides a solid foundation for any new JavaScript project, ensuring code quality and consistency from the start.
611

12+
<!-- Optional: Add a GIF demonstrating the pre-commit hook in action -->
13+
<!-- <p align="center">
14+
<img src="https://path-to-your/demo.gif" alt="Demonstration of pre-commit hooks" />
15+
</p> -->
16+
717
## What's Inside?
818

919
This template comes pre-configured with a suite of modern, industry-standard tools to ensure your project maintains high code quality.
@@ -78,7 +88,7 @@ If a file has linting or formatting errors, the tools will attempt to fix them a
7888

7989
### CI/CD Pipelines
8090

81-
This template includes one GitHub Action workflows located in the `.github/workflows` directory:
91+
This template includes one GitHub Action workflow located in the `.github/workflows` directory:
8292

8393
- **`ci.yml`**: This workflow runs on every push and pull request to the `main` branch. It acts as a final validation gate, ensuring that all tests, linting, and formatting checks pass before code is merged.
8494

0 commit comments

Comments
 (0)