Skip to content

Commit f1b5762

Browse files
authored
docs: add badges for CI and Coverage rate (#2487)
1 parent f5f5b1b commit f1b5762

File tree

4 files changed

+25
-1
lines changed

4 files changed

+25
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,18 @@
3131
[docs-faq]: https://sidorares.github.io/node-mysql2/docs/faq
3232
[docs-documentation]: https://sidorares.github.io/node-mysql2/docs/documentation
3333
[docs-contributing]: https://sidorares.github.io/node-mysql2/docs/contributing/website
34+
[coverage]: https://img.shields.io/codecov/c/github/sidorares/node-mysql2
35+
[coverage-url]: https://app.codecov.io/github/sidorares/node-mysql2
36+
[ci-url]: https://github.com/sidorares/node-mysql2/actions/workflows/ci-coverage.yml?query=branch%3Amaster
37+
[ci-image]: https://img.shields.io/github/actions/workflow/status/sidorares/node-mysql2/ci-coverage.yml?event=push&style=flat&label=CI&branch=master
3438

3539
# MySQL2
3640

3741
[![NPM Version][npm-image]][npm-url]
3842
[![NPM Downloads][downloads-image]][downloads-url]
3943
[![Node.js Version][node-version-image]][node-version-url]
44+
[![GitHub Workflow Status (with event)][ci-image]][ci-url]
45+
[![Codecov][coverage]][coverage-url]
4046
[![License][license-image]][license-url]
4147

4248
[English][docs-base] | [简体中文][docs-base-zh-CN] | [Português (BR)][docs-base-pt-BR]
@@ -102,7 +108,7 @@ npm install --save-dev @types/node
102108

103109
## Contributing
104110

105-
Want to improve something in **MySQL2**?
111+
Want to improve something in **MySQL2**?
106112
Please check [Contributing.md][contributing] for detailed instruction on how to get started.
107113

108114
To contribute in **MySQL2 Documentation**, please visit the [Website Contributing Guidelines][docs-contributing] for detailed instruction on how to get started.

website/docs/index.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ import { PageTitle } from '@site/src/components/PageTitle';
2020
[license-url]: https://github.com/sidorares/node-mysql2/blob/master/License
2121
[license-image]: https://img.shields.io/npm/l/mysql2.svg?maxAge=2592000
2222
[node-mysql]: https://github.com/mysqljs/mysql
23+
[coverage]: https://img.shields.io/codecov/c/github/sidorares/node-mysql2
24+
[coverage-url]: https://app.codecov.io/github/sidorares/node-mysql2
25+
[ci-url]: https://github.com/sidorares/node-mysql2/actions/workflows/ci-coverage.yml?query=branch%3Amaster
26+
[ci-image]: https://img.shields.io/github/actions/workflow/status/sidorares/node-mysql2/ci-coverage.yml?event=push&style=flat&label=CI&branch=master
2327

2428
# MySQL2
2529

@@ -30,6 +34,8 @@ MySQL client for Node.js with focus on performance. Supports prepared statements
3034
[![NPM Version][npm-image]][npm-url]
3135
[![NPM Downloads][downloads-image]][downloads-url]
3236
[![Node.js Version][node-version-image]][node-version-url]
37+
[![GitHub Workflow Status (with event)][ci-image]][ci-url]
38+
[![Codecov][coverage]][coverage-url]
3339
[![License][license-image]][license-url]
3440

3541
## Installation

website/i18n/pt-BR/docusaurus-plugin-content-docs/current/index.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Cliente MySQL para Node.js com foco em performance. Suporta instruções prepara
2020
[![NPM Version][npm-image]][npm-url]
2121
[![NPM Downloads][downloads-image]][downloads-url]
2222
[![Node.js Version][node-version-image]][node-version-url]
23+
[![GitHub Workflow Status (with event)][ci-image]][ci-url]
24+
[![Codecov][coverage]][coverage-url]
2325
[![License][license-image]][license-url]
2426

2527
## Instalação
@@ -510,3 +512,7 @@ Se você encontrou um erro, [registre-o no GitHub](https://github.com/sidorares/
510512
[license-url]: https://github.com/sidorares/node-mysql2/blob/master/License
511513
[license-image]: https://img.shields.io/npm/l/mysql2.svg?maxAge=2592000
512514
[node-mysql]: https://github.com/mysqljs/mysql
515+
[coverage]: https://img.shields.io/codecov/c/github/sidorares/node-mysql2
516+
[coverage-url]: https://app.codecov.io/github/sidorares/node-mysql2
517+
[ci-url]: https://github.com/sidorares/node-mysql2/actions/workflows/ci-coverage.yml?query=branch%3Amaster
518+
[ci-image]: https://img.shields.io/github/actions/workflow/status/sidorares/node-mysql2/ci-coverage.yml?event=push&style=flat&label=CI&branch=master

website/i18n/zh-CN/docusaurus-plugin-content-docs/current/index.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ import { PageTitle } from '@site/src/components/PageTitle';
2020
[![NPM Version][npm-image]][npm-url]
2121
[![NPM Downloads][downloads-image]][downloads-url]
2222
[![Node.js Version][node-version-image]][node-version-url]
23+
[![GitHub Workflow Status (with event)][ci-image]][ci-url]
24+
[![Codecov][coverage]][coverage-url]
2325
[![License][license-image]][license-url]
2426

2527
## 安装
@@ -510,3 +512,7 @@ If you've encountered an issue, please [file it on GitHub](https://github.com/si
510512
[license-url]: https://github.com/sidorares/node-mysql2/blob/master/License
511513
[license-image]: https://img.shields.io/npm/l/mysql2.svg?maxAge=2592000
512514
[node-mysql]: https://github.com/mysqljs/mysql
515+
[coverage]: https://img.shields.io/codecov/c/github/sidorares/node-mysql2
516+
[coverage-url]: https://app.codecov.io/github/sidorares/node-mysql2
517+
[ci-url]: https://github.com/sidorares/node-mysql2/actions/workflows/ci-coverage.yml?query=branch%3Amaster
518+
[ci-image]: https://img.shields.io/github/actions/workflow/status/sidorares/node-mysql2/ci-coverage.yml?event=push&style=flat&label=CI&branch=master

0 commit comments

Comments
 (0)