diff --git a/README.md b/README.md index 5d7b591..53515b1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ -# Fleet +

+ Ephemeral HTTP API tunnel +

-> Ephemeral HTTP API tunnel +

+ +

+ +--- + +

+ + GoDoc + + + + Last commit + + + + License + + + + Stars + + + + Issues + + + + Repo Size + + + + Follow on Twitter + +

+ +## 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) diff --git a/assets/fleet-architecture.png b/assets/fleet-architecture.png new file mode 100644 index 0000000..87b10da Binary files /dev/null and b/assets/fleet-architecture.png differ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..67e74ae Binary files /dev/null and b/assets/logo.png differ