Skip to content

Commit

Permalink
docs: Add asciinema demo to README & book
Browse files Browse the repository at this point in the history
  • Loading branch information
tazjin authored and Vincent Ambo committed Aug 15, 2019
1 parent e697367 commit 11cd6b7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 17 deletions.
25 changes: 8 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/src/nixery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 11cd6b7

Please sign in to comment.