diff --git a/README.md b/README.md new file mode 100644 index 0000000..2cfd306 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Heimdall +Heimdall is a peer-to-peer private network system. It uses [Wireguard](https://www.wireguard.com) for peer +communication and [Redis](https://redis.io) for backend storage. All nodes are equal and the system +auto-elects in the event of a current master failure. Non-node peers are also supported in which they +can only access the network but do not provide routing capabilities. + +![Heimdall](docs/overview.png) + +# diff --git a/docs/overview.png b/docs/overview.png new file mode 100644 index 0000000..11764b3 Binary files /dev/null and b/docs/overview.png differ