Skip to content

Commit 27cde8d

Browse files
committed
📚 docs(api-client): Add Conventional Commit badges to README
- Add version, maintainer, license, coverage, and minzipped size badges to the README - Update the package description to better reflect the purpose of the API client
1 parent 554983d commit 27cde8d

File tree

9 files changed

+149
-18
lines changed

9 files changed

+149
-18
lines changed

.badges.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"dir": ".github/badges",
3+
"files": [
4+
{
5+
"fileName": "version.svg",
6+
"label": "npm",
7+
"status": "2.1.8",
8+
"icon": "npm"
9+
},
10+
{
11+
"fileName": "coverage.svg",
12+
"label": "coverage",
13+
"status": "95.64",
14+
"icon": "vitest"
15+
},
16+
{
17+
"fileName": "size.svg",
18+
"label": "minzipped size",
19+
"status": "20037",
20+
"icon": "speed",
21+
"color": "43b816"
22+
},
23+
{
24+
"fileName": "maintainer.svg",
25+
"label": "maintainer",
26+
"status": "Localazy"
27+
},
28+
{
29+
"fileName": "license.svg",
30+
"label": "license",
31+
"status": "MIT"
32+
}
33+
]
34+
}

.github/badges/coverage.svg

Lines changed: 20 additions & 0 deletions
Loading

.github/badges/license.svg

Lines changed: 20 additions & 0 deletions
Loading

.github/badges/maintainer.svg

Lines changed: 20 additions & 0 deletions
Loading

.github/badges/size.svg

Lines changed: 20 additions & 0 deletions
Loading

.github/badges/version.svg

Lines changed: 20 additions & 0 deletions
Loading

.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ jobs:
3030
node-version-file: .nvmrc
3131
app-id: ${{ secrets.AUTH_APP_ID }}
3232
app-key: ${{ secrets.AUTH_APP_KEY }}
33+
badges: true
34+
badges-size: dist/browser/localazy-api-client.umd.min.js
3335

3436
publish:
3537
name: Publish Release

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
1-
<p align="center">
2-
<a href="https://localazy.com">
3-
<img src="https://localazy.com/directus9/assets/9fc36b9c-81b7-4dbf-bd82-b64cd984090f" width="285" height="50" alt="Localazy" >
4-
</a>
5-
</p>
6-
<p align="center">
7-
<a href="https://localazy.com/docs/api">
8-
<img src="https://localazy.com/directus9/assets/20866781-e69b-4e01-9456-05437487b75c" width="50" height="50" alt="localazy-api">
9-
</a>
10-
</p>
11-
121
<div align="center">
13-
<a href="https://github.com/localazy/api-client"><img src="https://img.shields.io/badge/@localazy-ts--api-066fef?style=for-the-badge" height="22" alt="@localazy/api-client"></a>
14-
<a href="https://npmjs.com/package/@localazy/api-client"><img src="https://img.shields.io/github/package-json/v/localazy/ts-api/main?style=for-the-badge&label=version&color=066fef" height="22" alt="npm"></a>
15-
<a href="https://github.com/localazy/api-client/blob/main/LICENSE"><img src="https://img.shields.io/github/license/localazy/ts-api?style=for-the-badge&color=066fef" height="22" alt="license"></a>
16-
</div>
172

18-
# 📦 Localazy API Client
3+
[<img src="https://localazy.com/directus9/assets/9fc36b9c-81b7-4dbf-bd82-b64cd984090f" width="285" height="50" alt="Localazy" >](https://localazy.com)
4+
5+
### 📦 `@localazy/api-client`
196

20-
> Node.js module that allows you to easily interact with the [Localazy API](https://localazy.com/docs/api).
7+
Node.js client for the [Localazy API](https://localazy.com/docs/api), providing a simple and type-safe way to integrate localization features into your JavaScript and TypeScript projects.
8+
9+
[![npm](.github/badges/version.svg)](https://www.npmjs.com/package/@localazy/api-client)
10+
[![maintainer](.github/badges/maintainer.svg)](https://github.com/localazy)
11+
[![license](.github/badges/license.svg)](https://github.com/localazy/api-client/blob/main/LICENSE)<br>
12+
[![coverage](.github/badges/coverage.svg)](https://github.com/localazy/api-client/actions)
13+
[![size](.github/badges/size.svg)](https://bundlephobia.com/package/@localazy/api-client)
14+
15+
</div>
2116

2217
## 🔧 Install
2318

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@localazy/api-client",
33
"version": "2.1.8",
4-
"description": "Node.js module that allows you to easily interact with the Localazy API.",
4+
"description": "Official Node.js client for the Localazy API, providing a simple and type-safe way to integrate localization features into your JavaScript and TypeScript projects.",
55
"keywords": [
66
"Localazy",
77
"Localazy API",

0 commit comments

Comments
 (0)