Add initial README

It is short and sweet for now
This commit is contained in:
Conrad Kramer 2023-04-10 18:44:02 -04:00
parent 39c3600022
commit 47f1312666

9
README.md Normal file
View file

@ -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.