Skip to content

Commit

Permalink
Add docs in README
Browse files Browse the repository at this point in the history
  • Loading branch information
murtaza-u committed Jan 16, 2024
1 parent 0f4b68a commit 35c6d97
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 2 deletions.
65 changes: 63 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,64 @@
# Fleet
<p align="center" width="100%">
Ephemeral HTTP API tunnel
</p>

> Ephemeral HTTP API tunnel
<p align="center" width="100%">
<img width="50%" src="./assets/logo.png">
</p>

---

<div align="center"><p>
<a href="https://godoc.org/github.com/murtaza-u/fleet">
<img alt="GoDoc" src="https://img.shields.io/badge/godoc-reference-5272B4.svg?style=for-the-badge&logo=github&color=30b976&logoColor=D9E0EE&labelColor=302D41"/>
</a>

<a href="https://github.com/murtaza-u/fleet/pulse">
<img alt="Last commit" src="https://img.shields.io/github/last-commit/murtaza-u/fleet?style=for-the-badge&logo=github&color=8bd5ca&logoColor=D9E0EE&labelColor=302D41"/>
</a>

<a href="https://github.com/murtaza-u/fleet/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/murtaza-u/fleet?style=for-the-badge&logo=github&color=ee999f&logoColor=D9E0EE&labelColor=302D41" />
</a>

<a href="https://github.com/murtaza-u/fleet/stargazers">
<img alt="Stars" src="https://img.shields.io/github/stars/murtaza-u/fleet?style=for-the-badge&logo=github&color=c69ff5&logoColor=D9E0EE&labelColor=302D41" />
</a>

<a href="https://github.com/murtaza-u/fleet/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/murtaza-u/fleet?style=for-the-badge&logo=bilibili&color=F5E0DC&logoColor=D9E0EE&labelColor=302D41" />
</a>

<a href="https://github.com/murtaza-u/fleet">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/murtaza-u/fleet?color=%23DDB6F2&label=SIZE&logo=codesandbox&style=for-the-badge&logoColor=D9E0EE&labelColor=302D41" />
</a>

<a href="https://twitter.com/intent/follow?screen_name=murtaza_u_">
<img alt="Follow on Twitter" src="https://img.shields.io/twitter/follow/murtaza_u_?style=for-the-badge&logo=twitter&color=8aadf3&logoColor=D9E0EE&labelColor=302D41" />
</a>
</p></div>

## Features

* Ephemeral
* Zero-effort TLS
* No hole-punching or port forwarding required
* Fast

## Demo - serve static files

[![asciicast](https://asciinema.org/a/6lfmWZGfJDPwO8DYoCNG9WJwM.svg)](https://asciinema.org/a/6lfmWZGfJDPwO8DYoCNG9WJwM)

## Demo - proxy requests to local running server

[![asciicast](https://asciinema.org/a/jCQ3AUDPLRKL55tX3kqWTCnIY.svg)](https://asciinema.org/a/jCQ3AUDPLRKL55tX3kqWTCnIY)

## SDK

Explore the provided [examples](./example), and for a comprehensive API
reference, please visit
[GoDoc](https://godoc.org/github.com/murtaza-u/fleet).

## Architecture

![Fleet Architecture](./assets/fleet-architecture.png)
Binary file added assets/fleet-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 35c6d97

Please sign in to comment.