docs: add readme (#10)

Signed-off-by: Artur Troian <[email protected]>
akash-network · Aug 8, 2024 · b6dbaf3 · b6dbaf3
1 parent e184b85
commit b6dbaf3
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md 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