From 47f13126661b66a53b5242369637801f972799f9 Mon Sep 17 00:00:00 2001 From: Conrad Kramer Date: Mon, 10 Apr 2023 18:44:02 -0400 Subject: [PATCH] Add initial README It is short and sweet for now --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a89463 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Burrow + +![License](https://img.shields.io/github/license/hackclub/burrow) ![Apple Build Status](https://img.shields.io/github/actions/workflow/status/hackclub/burrow/build-apple.yml?branch=main&label=macos%2C%20ios&logo=Apple) ![Crate Build Status](https://img.shields.io/github/actions/workflow/status/hackclub/burrow/build-rust.yml?branch=main&label=crate&logo=Rust) + +Burrow is a tool for burrowing through firewalls, built by teenagers at [Hack Club](https://hackclub.com/). + +At its core, `burrow` is a command line utility written in Rust that can open virtual interfaces and direct traffic through them. + +You can use it directly from the command line, or you can use it wrapped inside of an app. Currently, there are apps for iOS and macOS that you can use to start the tunnel.