about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@google.com>2019-08-17T09·07+0100
committerVincent Ambo <github@tazj.in>2019-08-17T09·10+0100
commit0ee239874b76bea75a3d3a90201118b3c4294576 (patch)
tree6dd7abb6a9d217009d26eb853dc0d269b30b854b
parent3b65fc8c726a91eb155ff2e5bf116e5aeee488aa (diff)
docs(README): Update links to layering strategy
-rw-r--r--tools/nixery/README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/tools/nixery/README.md b/tools/nixery/README.md
index 8225e430b36e..cdae23bc4b72 100644
--- a/tools/nixery/README.md
+++ b/tools/nixery/README.md
@@ -14,14 +14,16 @@ user intends to include in the image is specified as a path component of the
 image name.
 
 The path components refer to top-level keys in `nixpkgs` and are used to build a
-container image using Nix's [buildLayeredImage][] functionality.
+container image using a [layering strategy][] that optimises for caching popular
+and/or large dependencies.
 
 A public instance as well as additional documentation is available at
 [nixery.dev][public].
 
-The project started out with the intention of becoming a Kubernetes controller
-that can serve declarative image specifications specified in CRDs as container
-images. The design for this is outlined in [a public gist][gist].
+The project started out inspired by the [buildLayeredImage][] blog post with the
+intention of becoming a Kubernetes controller that can serve declarative image
+specifications specified in CRDs as container images. The design for this was
+outlined in [a public gist][gist].
 
 This is not an officially supported Google project.
 
@@ -94,6 +96,7 @@ correct caching behaviour, addressing and so on.
 See [issue #4](https://github.com/google/nixery/issues/4).
 
 [Nix]: https://nixos.org/
+[layering strategy]: https://storage.googleapis.com/nixdoc/nixery-layers.html
 [gist]: https://gist.github.com/tazjin/08f3d37073b3590aacac424303e6f745
 [buildLayeredImage]: https://grahamc.com/blog/nix-and-layered-docker-images
 [public]: https://nixery.dev