Skip to content

Commit e813786

Browse files
docs: README with badges, better copy, landing link
1 parent b3a485d commit e813786

1 file changed

Lines changed: 35 additions & 10 deletions

File tree

README.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
1+
<div align="center">
2+
13
# httpsdev
24

3-
**Zero-config HTTPS for any local dev server.**
5+
**Localhost with a working padlock.**
6+
7+
Point it at a port. Get a green padlock.
8+
9+
[![Release](https://img.shields.io/github/v/release/ArpitRajputGithub/httpsdev?style=flat-square&color=cba6f7&labelColor=1e1e2e)](https://github.com/ArpitRajputGithub/httpsdev/releases)
10+
[![Go Reference](https://img.shields.io/badge/go-reference-cba6f7?style=flat-square&labelColor=1e1e2e)](https://pkg.go.dev/github.com/ArpitRajputGithub/httpsdev)
11+
[![License](https://img.shields.io/badge/license-MIT-cba6f7?style=flat-square&labelColor=1e1e2e)](LICENSE)
12+
[![CI](https://img.shields.io/github/actions/workflow/status/ArpitRajputGithub/httpsdev/ci.yml?style=flat-square&labelColor=1e1e2e&color=a6e3a1)](https://github.com/ArpitRajputGithub/httpsdev/actions)
13+
14+
<!-- Swap this for a real GIF after `vhs demo.tape` runs. See demo.tape. -->
15+
<!-- <img src=".github/demo.gif" alt="httpsdev demo" width="720" /> -->
16+
17+
</div>
18+
19+
---
420

521
```
622
$ mkcert -install # one time, system-wide
@@ -11,7 +27,13 @@ Real browser-trusted cert. Works with Vite, Next, Rails, Django, Flask — any H
1127

1228
## Why
1329

14-
Every framework has its own HTTPS story (`--https`, `HTTPS=true`, experimental configs) and most default to self-signed certs that trip browser warnings, break service workers, and blow up OAuth callbacks. `httpsdev` sits in front of your existing dev server and gives it real HTTPS in one command.
30+
Every framework has its own broken HTTPS story. Some ship self-signed certs that trip the browser. Some hide it behind an `HTTPS=true` env var. Some just don't. `httpsdev` sits in front of any dev server and hands it a real, browser-trusted cert — the kind that comes from mkcert's local CA, so Chrome and Safari already trust it.
31+
32+
Specifically fixes:
33+
- Service workers refusing to register over `http://`
34+
- OAuth callbacks rejecting non-HTTPS redirect URIs (Google, GitHub, Auth0)
35+
- `Secure` / `SameSite=None` / `__Host-` cookies not surviving the round-trip
36+
- WebAuthn, Web Crypto, clipboard, camera/mic APIs gated behind secure context
1537

1638
## Install
1739

@@ -25,12 +47,13 @@ mkcert -install
2547
Then:
2648

2749
```bash
28-
# Homebrew (coming in v0.2)
29-
30-
# Go install
50+
# Go install (Go users)
3151
go install github.com/ArpitRajputGithub/httpsdev@latest
3252

33-
# Or grab a binary from Releases:
53+
# Homebrew (coming in v0.2)
54+
# brew install ArpitRajputGithub/tap/httpsdev
55+
56+
# Or grab a prebuilt binary from Releases:
3457
# https://github.com/ArpitRajputGithub/httpsdev/releases
3558
```
3659

@@ -70,9 +93,7 @@ POST /api/login 401 45ms
7093
httpsdev --tui 5173
7194
```
7295

73-
Full-screen Catppuccin Mocha TUI with live request feed, latency stats, and cert info tab.
74-
75-
*(GIF placeholder — record with asciinema after v0.1 tag)*
96+
Full-screen Catppuccin Mocha TUI with live request feed, latency stats, and connection info. The wordmark alone justifies the download.
7697

7798
### Test on your phone
7899

@@ -88,7 +109,11 @@ Binds on `0.0.0.0`. Your phone (on the same wifi) can hit `https://<mac-ip>:3443
88109
- Multi-service reverse proxy (`api.dev.local`, `web.dev.local`) — use [Caddy](https://caddyserver.com) for that.
89110
- Framework detection.
90111

91-
All tracked as issues for v0.2+.
112+
All tracked as [issues](https://github.com/ArpitRajputGithub/httpsdev/issues) for v0.2+.
113+
114+
## Website
115+
116+
<https://httpsdev.pages.dev> — landing page with a live TUI preview.
92117

93118
## License
94119

0 commit comments

Comments
 (0)