mirror of
https://github.com/samsonjs/vibetunnel.git
synced 2026-04-25 14:57:37 +00:00
feat: enhance README with centered header, badges, and table of contents
- Center VibeTunnel banner and title for better visual impact - Organize badges in two centered rows for cleaner layout - Add Twitter follow badge for @vibetunnel - Add quick navigation links (Documentation, Releases, Discord, Twitter) - Add comprehensive table of contents for easy navigation - Follow design patterns from successful projects like Caddy
This commit is contained in:
parent
e6596050ec
commit
22f77c7b93
1 changed files with 54 additions and 14 deletions
68
README.md
68
README.md
|
|
@ -1,21 +1,61 @@
|
|||
<!-- Generated: 2025-06-21 18:45:00 UTC -->
|
||||

|
||||
<p align="center">
|
||||
<img src="assets/banner.png" alt="VibeTunnel Banner" />
|
||||
</p>
|
||||
|
||||
# VibeTunnel
|
||||
<h1 align="center">VibeTunnel</h1>
|
||||
|
||||
**Turn any browser into your Mac terminal.** VibeTunnel proxies your terminals right into the browser, so you can vibe-code anywhere.
|
||||
<p align="center">
|
||||
<strong>Turn any browser into your Mac terminal.</strong><br>
|
||||
VibeTunnel proxies your terminals right into the browser, so you can vibe-code anywhere.
|
||||
</p>
|
||||
|
||||
[](https://github.com/amantus-ai/vibetunnel/releases/latest)
|
||||
[](https://www.npmjs.com/package/vibetunnel)
|
||||
[](https://formulae.brew.sh/cask/vibetunnel)
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/3Ub3EUwrcR)
|
||||
[](https://www.npmjs.com/package/vibetunnel)
|
||||
[](LICENSE)
|
||||
[](https://www.apple.com/macos/)
|
||||
[](https://support.apple.com/en-us/HT211814)
|
||||
[](https://vibetunnel.sh/#support)
|
||||
[](https://deepwiki.com/amantus-ai/vibetunnel)
|
||||
<p align="center">
|
||||
<a href="https://github.com/amantus-ai/vibetunnel/releases/latest"><img src="https://img.shields.io/badge/Download-macOS-blue" alt="Download"></a>
|
||||
<a href="https://www.npmjs.com/package/vibetunnel"><img src="https://img.shields.io/npm/v/vibetunnel.svg" alt="npm version"></a>
|
||||
<a href="https://formulae.brew.sh/cask/vibetunnel"><img src="https://img.shields.io/homebrew/cask/v/vibetunnel" alt="Homebrew"></a>
|
||||
<a href="https://nodejs.org"><img src="https://img.shields.io/badge/Node.js-20+-339933?logo=node.js" alt="Node.js 20+"></a>
|
||||
<a href="https://discord.gg/3Ub3EUwrcR"><img src="https://img.shields.io/discord/1394471066990280875?label=Discord&logo=discord" alt="Discord"></a>
|
||||
<a href="https://twitter.com/vibetunnel"><img src="https://img.shields.io/twitter/follow/vibetunnel?style=social" alt="Twitter"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/vibetunnel"><img src="https://img.shields.io/badge/Linux-Supported-brightgreen" alt="Linux Support"></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green" alt="License"></a>
|
||||
<a href="https://www.apple.com/macos/"><img src="https://img.shields.io/badge/macOS-14.0+-red" alt="macOS 14.0+"></a>
|
||||
<a href="https://support.apple.com/en-us/HT211814"><img src="https://img.shields.io/badge/Apple%20Silicon-Required-orange" alt="Apple Silicon"></a>
|
||||
<a href="https://vibetunnel.sh/#support"><img src="https://img.shields.io/badge/Support%20us-on%20Polar-purple" alt="Support us on Polar"></a>
|
||||
<a href="https://deepwiki.com/amantus-ai/vibetunnel"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://docs.vibetunnel.sh">Documentation</a> •
|
||||
<a href="https://github.com/amantus-ai/vibetunnel/releases">Releases</a> •
|
||||
<a href="https://discord.gg/3Ub3EUwrcR">Discord</a> •
|
||||
<a href="https://twitter.com/vibetunnel">Twitter</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Why VibeTunnel?](#why-vibetunnel)
|
||||
- [Installation Options](#installation-options)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Features](#features)
|
||||
- [Architecture](#architecture)
|
||||
- [Remote Access Options](#remote-access-options)
|
||||
- [Terminal Title Management](#terminal-title-management)
|
||||
- [Authentication](#authentication)
|
||||
- [npm Package](#npm-package)
|
||||
- [Building from Source](#building-from-source)
|
||||
- [Development](#development)
|
||||
- [Documentation](#documentation)
|
||||
- [macOS Permissions](#macos-permissions)
|
||||
- [Contributing](#contributing)
|
||||
- [Support VibeTunnel](#support-vibetunnel)
|
||||
- [Credits](#credits)
|
||||
- [License](#license)
|
||||
|
||||
## Why VibeTunnel?
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue