diff --git a/README.md b/README.md index 2e8e64760be2f..3d0bb35b82d31 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# tailscale -Tailscale +# Tailscale + +http://tailscale.com + +Private WireGuard® networks made easy + +## Overview + +This repository contains all the open source Tailscale code. +It currently includes the Linux client. + +The linux client is currently `cmd/relaynode`, but will +soon be replaced by `cmd/tailscaled`. + +## Building + +``` +go install tailscale.com/cmd/tailscale{,d} +``` + +## Bugs + +Please file any issues on the GitHub issue tracker. + +## Contributing + +PRs welcome, but we are still working out our contribution process. + +`under_construction.gif` + +## About Us + +We are apenwarr, bradfitz, crawshaw, danderson, dfcarney, +from Tailscale Inc. You can learn more about us from our website. + +WireGuard is a registered trademark of Jason A. Donenfeld.