From d728a7919759ac9060ea1c02593c1857e66312fe Mon Sep 17 00:00:00 2001 From: Artur Troian Date: Thu, 8 Aug 2024 16:29:56 -0500 Subject: [PATCH] docs: add readme Signed-off-by: Artur Troian --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..be3366f --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Vanity URL + +Akash Network [Vanity URL](https://gianarb.it/blog/go-mod-vanity-url) for go mods. +We use [vangen](https://github.com/leighmcculloch/vangen) for generating this repo. + +## How to add a module + +- Make sure [direnv](https://direnv.net) is installed. It will install `vangen` util into local cache +- Make changes to `vangen.json` +- `make vangen` +- Push your changes