diff options
author | Vincent Ambo <tazjin@google.com> | 2019-08-15T11·00+0100 |
---|---|---|
committer | Vincent Ambo <github@tazj.in> | 2019-08-15T15·04+0100 |
commit | 3f232e017075f5b45c7d11cdf27225a51f47c085 (patch) | |
tree | 3347f5d66872545c3cfa5f0b577437c8ee76f8d4 | |
parent | 0ec369d76c2b151fa82839230e6eb4d58015b1dc (diff) |
docs: Add asciinema demo to README & book
-rw-r--r-- | tools/nixery/README.md | 25 | ||||
-rw-r--r-- | tools/nixery/docs/src/nixery.md | 4 |
2 files changed, 12 insertions, 17 deletions
diff --git a/tools/nixery/README.md b/tools/nixery/README.md index 9c323a57fa12..8225e430b36e 100644 --- a/tools/nixery/README.md +++ b/tools/nixery/README.md @@ -25,23 +25,14 @@ images. The design for this is outlined in [a public gist][gist]. This is not an officially supported Google project. -## Usage example - -Using the publicly available Nixery instance at `nixery.dev`, one could -retrieve a container image containing `curl` and an interactive shell like this: - -```shell -tazjin@tazbox:~$ sudo docker run -ti nixery.dev/shell/curl bash -Unable to find image 'nixery.dev/shell/curl:latest' locally -latest: Pulling from shell/curl -7734b79e1ba1: Already exists -b0d2008d18cd: Pull complete -< ... some layers omitted ...> -Digest: sha256:178270bfe84f74548b6a43347d73524e5c2636875b673675db1547ec427cf302 -Status: Downloaded newer image for nixery.dev/shell/curl:latest -bash-4.4# curl --version -curl 7.64.0 (x86_64-pc-linux-gnu) libcurl/7.64.0 OpenSSL/1.0.2q zlib/1.2.11 libssh2/1.8.0 nghttp2/1.35.1 -``` +## Demo + +Click the image to see an example in which an image containing an interactive +shell and GNU `hello` is downloaded. + +[![asciicast](https://asciinema.org/a/262583.png)](https://asciinema.org/a/262583?autoplay=1) + +To try it yourself, head to [nixery.dev][public]! The special meta-package `shell` provides an image base with many core components (such as `bash` and `coreutils`) that users commonly expect in diff --git a/tools/nixery/docs/src/nixery.md b/tools/nixery/docs/src/nixery.md index 3eaeb6be4e97..edea53bab62e 100644 --- a/tools/nixery/docs/src/nixery.md +++ b/tools/nixery/docs/src/nixery.md @@ -13,6 +13,10 @@ cache efficiency. For general information on why using Nix makes sense for container images, check out [this blog post][layers]. +## Demo + +<script src="https://asciinema.org/a/262583.js" id="asciicast-262583" async data-autoplay="true" data-loop="true"></script> + ## Quick start Simply pull an image from this registry, separating each package you want |