diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a0e35b --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# bndd +## The daemon for boundaries + +### Note: This repository is part of the [boundaries](https://github.com/pauljako/boundaries) rewrite as a client/server model. Once it is completed, the old boundaries will be deprecated. + +## Installing +#### Note: Currently, bndd requires another boundaries installation to already be installed. + +You can compile the package with the following command (assuming [bpb](https://github.com/pauljako/bpb) and go are installed): +```shell +bpb . +``` + +After that you can install the built package inside the package/ directory