about summary refs log tree commit diff
path: root/tvix/nar-bridge-go/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tvix/nar-bridge-go/README.md')
-rw-r--r--tvix/nar-bridge-go/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/tvix/nar-bridge-go/README.md b/tvix/nar-bridge-go/README.md
new file mode 100644
index 000000000000..81431daf38ff
--- /dev/null
+++ b/tvix/nar-bridge-go/README.md
@@ -0,0 +1,7 @@
+# //tvix/nar-bridge-go
+
+This exposes a HTTP Binary cache interface (GET/HEAD/PUT requests) for a `tvix-
+store`.
+
+It can be used to configure a tvix-store as a substitutor for Nix, or to upload
+store paths from Nix via `nix copy` into a `tvix-store`.