docs: extended readme

Signed-off-by: András Jáky <ajaky@cisco.com>

Author: akijakya

README.md

@@ -3,3 +3,95 @@
 ## Description
 
 A tool to watch secret changes in Vault since deploying a workload that uses them via `vault-secrets-webhook`, and "reloads" them so the `webhook` injects the latest secret versions into the objects.
+
+## Documentation
+
+The official documentation for the reloader will be available at [https://bank-vaults.dev](https://bank-vaults.dev/docs/).
+
+## Development
+
+**For an optimal developer experience, it is recommended to install [Nix](https://nixos.org/download.html) and [direnv](https://direnv.net/docs/installation.html).**
+
+_Alternatively, install [Go](https://go.dev/dl/) on your computer then run `make deps` to install the rest of the dependencies._
+
+Make sure Docker is installed with Compose and Buildx.
+
+Run project dependencies:
+
+```shell
+make deps
+
+make up
+```
+
+Port-forward Vault:
+
+```shell
+export VAULT_TOKEN=$(kubectl get secrets vault-unseal-keys -o jsonpath={.data.vault-root} | base64 --decode)
+
+kubectl get secret vault-tls -o jsonpath="{.data.ca\.crt}" | base64 --decode > $PWD/vault-ca.crt
+export VAULT_CACERT=$PWD/vault-ca.crt
+
+export VAULT_ADDR=https://127.0.0.1:8200
+
+kubectl port-forward service/vault 8200 &
+```
+
+Run the reloader:
+
+```shell
+make run
+```
+
+Run the test suite:
+
+```shell
+make test
+
+make container-image
+make test-e2e-local
+```
+
+Run linters:
+
+```shell
+make lint # pass -j option to run them in parallel
+```
+
+Some linter violations can automatically be fixed:
+
+```shell
+make fmt
+```
+
+Build artifacts locally:
+
+```shell
+make artifacts
+```
+
+Once you are done either stop or tear down dependencies:
+
+```shell
+make down
+```
+
+### Running e2e tests
+
+The project comes with an e2e test suite that is mostly self-contained,
+but at the very least, you need Docker installed.
+
+By default, the suite launches a [KinD](https://kind.sigs.k8s.io/) cluster, deploys all necessary components and runs the test suite.
+This is a good option if you want to run the test suite to make sure everything works. This is also how the CI runs the test suite
+(with a few minor differences).
+
+You can run the test suite by running the following commands:
+
+```shell
+make container-image
+make test-e2e-local
+```
+
+## License
+
+The project is licensed under the [Apache 2.0 License](LICENSE).