tidy readme
Kim committed
Mar 5, 2026 at 11:52 UTC
db9145753dade37421118b66a2ed16962b9369b5
1 file changed
+9
-7
README.md
+9
-7
@@ -26,11 +26,9 @@ and routes incoming traffic while preserving end-to-end TLS.
26
27
- **NAT-friendly connectivity**: Works behind NAT or firewalls without opening inbound ports
28
- **Automatic subdomain routing**: Gives each app its own subdomain (`your-app.<base-domain>`)
29
-- **Non-apex `PORTAL_URL` friendly**: Route hosts are derived from the full portal host (e.g., `https://portal.example.com:8443` -> `portal.example.com`), so services become `<name>.portal.example.com`
29
- **End-to-end encryption**: Supports TLS passthrough with relay keyless certificates
31
-- **Self-hosted by design**: You can run your own Portal relay
32
-- **Fast setup**: Expose a local app with a short command flow
33
-- **Central anti-abuse enforcement**: `/sdk/register` and `/sdk/connect` use the same admin-managed policy controls (IP bans, lease authorization) before accepting a tunnel
30
+- **Permissionless Hosting**: Anyone can run their own Portal — no approval needed
31
+- **One-Command Setup**: Expose any local app with a single command
32
33
## Components
34
@@ -69,9 +67,13 @@ For architecture decisions, see [docs/adr/README.md](docs/adr/README.md).
67
68
## Contributing
69
72
-1. Fork the repository.
73
-2. Create a feature branch and make your changes.
74
-3. Open a Pull Request.
70
+We welcome contributions from the community!
71
+
72
+1. Fork the repository
73
+2. Create a feature branch (git checkout -b feature/amazing-feature)
74
+3. Commit your changes (git commit -m 'Add amazing feature')
75
+4. Push to the branch (git push origin feature/amazing-feature)
76
+5. Open a Pull Request
77
78
## License
79