Skip to content

Commit 8ee2dd4

Browse files
committed
docs: add live demo and update logo to webp
1 parent 1c7f5bf commit 8ee2dd4

9 files changed

Lines changed: 900 additions & 6 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
node_modules
22
dist
33
coverage
4+
sites
45

56
*.tsbuildinfo

.vscode/pushforge.code-workspace

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
{
44
"path": "../packages/builder",
55
},
6+
{
7+
"path": "../sites/test",
8+
},
69
{
710
"path": "..",
811
},

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
<img src="images/pushforge_logo.png" alt="PushForge Logo" width="120" />
3+
<img src="images/logo.webp" alt="PushForge Logo" width="120" />
44

55
# PushForge
66

@@ -14,10 +14,23 @@ Zero dependencies · Works everywhere · TypeScript-first
1414

1515
[Documentation](packages/builder) · [npm](https://www.npmjs.com/package/@pushforge/builder) · [Report Bug](https://github.com/draphy/pushforge/issues)
1616

17+
**[Try the Live Demo →](https://pushforge.draphy.org)**
18+
1719
</div>
1820

1921
---
2022

23+
## Live Demo
24+
25+
See PushForge in action at **[pushforge.draphy.org](https://pushforge.draphy.org)** — a fully working test site powered by PushForge on Cloudflare Workers.
26+
27+
- **Enable push notifications** on your device with a single toggle
28+
- **Send a test notification** to all active devices — anyone visiting the page can send and receive
29+
- **See it working across browsers** — Chrome, Firefox, Edge, Safari 16+, and more
30+
- Subscriptions auto-expire after 5 minutes — no permanent data stored
31+
32+
The entire backend is a single Cloudflare Worker using `buildPushHTTPRequest()` from `@pushforge/builder` with zero additional dependencies.
33+
2134
## The Problem
2235

2336
Traditional web push libraries like `web-push` rely on Node.js-specific APIs that don't work in modern edge runtimes:

biome.json

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://biomejs.dev/schemas/1.5.3/schema.json",
2+
"$schema": "https://biomejs.dev/schemas/1.9.0/schema.json",
33
"organizeImports": {
44
"enabled": true
55
},
@@ -15,7 +15,15 @@
1515
"useImportType": "error"
1616
}
1717
},
18-
"ignore": ["dist", "node_modules", "build", "tmp", "dev-dist", ".vscode"]
18+
"ignore": [
19+
"dist",
20+
"node_modules",
21+
"build",
22+
"tmp",
23+
"dev-dist",
24+
".vscode",
25+
"sites"
26+
]
1927
},
2028
"formatter": {
2129
"enabled": true,
@@ -29,7 +37,8 @@
2937
"build",
3038
"tmp",
3139
"dev-dist",
32-
".vscode"
40+
".vscode",
41+
"sites"
3342
]
3443
},
3544
"javascript": {

images/logo.webp

15.7 KB
Loading

images/pushforge_logo.png

-999 KB
Binary file not shown.

packages/builder/README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
1+
<div align="center">
2+
3+
<img src="https://raw.githubusercontent.com/draphy/pushforge/master/images/logo.webp" alt="PushForge Logo" width="120" />
4+
15
# PushForge Builder
26

3-
A lightweight, dependency-free Web Push library built on the standard Web Crypto API. Send push notifications from any JavaScript runtime.
7+
**A lightweight, dependency-free Web Push library built on the standard Web Crypto API.**
8+
9+
[![npm version](https://img.shields.io/npm/v/@pushforge/builder.svg)](https://www.npmjs.com/package/@pushforge/builder)
10+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
11+
[![TypeScript](https://img.shields.io/badge/TypeScript-first--class-blue.svg)](https://www.typescriptlang.org/)
12+
13+
Send push notifications from any JavaScript runtime · Zero dependencies
14+
15+
[GitHub](https://github.com/draphy/pushforge) · [npm](https://www.npmjs.com/package/@pushforge/builder) · [Report Bug](https://github.com/draphy/pushforge/issues)
16+
17+
**[Try the Live Demo →](https://pushforge.draphy.org)**
18+
19+
</div>
20+
21+
---
422

523
```bash
624
npm install @pushforge/builder
725
```
826

27+
## Live Demo
28+
29+
Try PushForge in your browser at **[pushforge.draphy.org](https://pushforge.draphy.org)** — a live test site running on Cloudflare Workers.
30+
31+
- Toggle push notifications on, send a test message, and see it arrive in real time
32+
- Works across all supported browsers — Chrome, Firefox, Edge, Safari 16+
33+
- The backend is a single Cloudflare Worker using `buildPushHTTPRequest()` with zero additional dependencies
34+
- Subscriptions auto-expire after 5 minutes — no permanent data stored
35+
936
## Why PushForge?
1037

1138
| | PushForge | web-push |

0 commit comments

Comments
 (0)