Skip to content

Commit 82363ce

Browse files
committed
docs: live docs URL in README + package homepage; fix license/build badges; WhatsApp link in docs navbar
1 parent bb9deb9 commit 82363ce

3 files changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@
1010
<a href="https://www.npmjs.com/package/zaileys"><img src="https://img.shields.io/npm/v/zaileys.svg" alt="NPM Version"></a>
1111
<a href="https://www.npmjs.com/package/zaileys"><img src="https://img.shields.io/npm/dw/zaileys?label=npm&color=%23CB3837" alt="NPM Downloads"></a>
1212
<a href="https://github.com/zeative/zaileys/releases"><img src="https://img.shields.io/npm/dt/zaileys" alt="NPM Downloads"></a>
13-
<a href="https://github.com/zeative/zaileys/actions"><img src="https://img.shields.io/github/actions/workflow/status/zeative/zaileys/ci.yml?branch=main&label=build" alt="Build Status"></a>
1413
<a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/badge/TypeScript-7%20native-blue?style=flat-square&logo=typescript" alt="TypeScript 7"></a>
1514
</div>
1615

1716
<div align="center">
18-
<a href="https://github.com/zeative/zaileys/blob/main/LICENSE"><img src="https://img.shields.io/github/license/zeative/zaileys" alt="GitHub License"></a>
17+
<a href="https://github.com/zeative/zaileys/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="License: MIT"></a>
1918
<a href="https://discord.gg/KBHhTTVUc5"><img alt="Discord" src="https://img.shields.io/discord/1105833273415962654?logo=discord&label=discord&link=https%3A%2F%2Fgithub.com%2Fzeative%2Fzaileys"></a>
2019
<a href="https://chat.whatsapp.com/GlQfvc83mSH3F6ov06vuCt"><img alt="WhatsApp" src="https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp&logoColor=white"></a>
2120
<a href="https://github.com/zeative/zaileys"><img src="https://img.shields.io/github/stars/zeative/zaileys" alt="GitHub Stars"></a>
@@ -39,7 +38,7 @@
3938
[What you can build](#what-you-can-build) &nbsp;&nbsp;
4039
[Storage](#storage) &nbsp;&nbsp;
4140
[Runtimes](#runtime-support) &nbsp;&nbsp;
42-
[Docs](#documentation)
41+
[Docs](https://zeative.github.io/zaileys/)
4342

4443
</div>
4544

@@ -48,7 +47,7 @@
4847
<br>
4948

5049
> [!NOTE]
51-
> This README is a **high-level overview**. The complete API reference, guides, and recipes live in the dedicated documentation site (coming soon). Runnable code lives in [`examples/`](./examples).
50+
> This README is a **high-level overview**. The complete API reference, guides, and recipes live in the documentation site at **<https://zeative.github.io/zaileys/>**. Runnable code lives in [`examples/`](./examples).
5251
5352
---
5453

@@ -218,6 +217,7 @@ Package managers: **npm**, **pnpm**, **yarn**, and **bun** are all supported.
218217

219218
## Documentation
220219

220+
- 🌐 [**zeative.github.io/zaileys**](https://zeative.github.io/zaileys/) — full documentation site: guides, API reference, recipes
221221
- 📦 [**examples/**](./examples) — runnable bots: quickstart, interactive buttons, AIRich, storage adapters, broadcast
222222
- 🔀 [**MIGRATION.md**](./MIGRATION.md) — upgrading from v3.x to v4.0.0 (breaking changes, side-by-side snippets)
223223
- 🤝 [**CONTRIBUTING.md**](./CONTRIBUTING.md) — dev setup, tests, commit convention, release flow

docs/app/layout.jsx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,19 @@ const navbar = (
2929
}
3030
projectLink="https://github.com/zeative/zaileys"
3131
chatLink="https://discord.gg/KBHhTTVUc5"
32-
/>
32+
>
33+
<a
34+
href="https://chat.whatsapp.com/GlQfvc83mSH3F6ov06vuCt"
35+
target="_blank"
36+
rel="noreferrer"
37+
title="WhatsApp Group"
38+
style={{ display: 'inline-flex', alignItems: 'center', padding: '0.25rem' }}
39+
>
40+
<svg width="22" height="22" viewBox="0 0 24 24" fill="#25D366" aria-label="WhatsApp">
41+
<path d="M.057 24l1.687-6.163a11.867 11.867 0 01-1.587-5.946C.16 5.335 5.495 0 12.05 0a11.82 11.82 0 018.413 3.488 11.824 11.824 0 013.48 8.414c-.003 6.557-5.338 11.892-11.893 11.892a11.9 11.9 0 01-5.688-1.448L.057 24zm6.597-3.807c1.676.995 3.276 1.591 5.392 1.592 5.448 0 9.886-4.434 9.889-9.885.002-5.462-4.415-9.89-9.881-9.892-5.452 0-9.887 4.434-9.889 9.884a9.86 9.86 0 001.51 5.26l-.999 3.648 3.728-.999zm11.387-5.464c-.074-.124-.272-.198-.57-.347-.297-.149-1.758-.868-2.031-.967-.272-.099-.47-.149-.669.149-.198.297-.768.967-.941 1.165-.173.198-.347.223-.644.074-.297-.149-1.255-.462-2.39-1.475-.883-.788-1.48-1.761-1.653-2.059-.173-.297-.018-.458.13-.606.134-.133.297-.347.446-.521.151-.172.2-.296.3-.495.099-.198.05-.372-.025-.521-.075-.148-.669-1.611-.916-2.206-.242-.579-.487-.501-.669-.51l-.57-.01c-.198 0-.52.074-.792.372-.272.297-1.04 1.016-1.04 2.479 0 1.462 1.065 2.875 1.213 3.074.149.198 2.095 3.2 5.076 4.487.709.306 1.263.489 1.694.626.712.226 1.36.194 1.872.118.571-.085 1.758-.719 2.006-1.413.248-.694.248-1.289.173-1.413z" />
42+
</svg>
43+
</a>
44+
</Navbar>
3345
)
3446
const footer = <Footer>MIT {new Date().getFullYear()} © Zaileys.</Footer>
3547

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,13 @@
1111
"dist"
1212
],
1313
"author": "zaadevofc",
14+
"homepage": "https://zeative.github.io/zaileys/",
1415
"repository": {
1516
"url": "git+https://github.com/zeative/zaileys.git"
1617
},
18+
"bugs": {
19+
"url": "https://github.com/zeative/zaileys/issues"
20+
},
1721
"keywords": [
1822
"baileys",
1923
"zaileys",

0 commit comments

Comments
 (0)