doc: add info re: current images, ad a toc

This commit is contained in:
Jason Swank 2023-05-09 11:56:30 -04:00
parent a61b1d2aaa
commit eeb1169a0b

View File

@ -4,9 +4,15 @@ A minimal image for running Linux CLI utilities - shell scripts and similar.
This is useful for interactive purposes or as the basis for other utility This is useful for interactive purposes or as the basis for other utility
images. images.
* [Quickstart](#quickstart)
* [More Info](#more-info)
* [Available Images](#available-images)
* [Helper Script](#helper-script)
* [License](#license)
## Quickstart ## Quickstart
```console ```console
$ docker run -ti --rm ghcr.io/jswank/alpine-cli $ docker run -ti --rm ghcr.io/jswank/alpine-cli:3
~ $ ^D ~ $ ^D
exit exit
@ -25,6 +31,13 @@ for the specifics.
- A user is created with sudo (`-u root`) access. - A user is created with sudo (`-u root`) access.
- A few personal preferences are enabled via dotfiles. - A few personal preferences are enabled via dotfiles.
## Available Images
See ghcr.io/jswank/alpine-cli for current available images.
## Helper Script
A helper script, using [casey/just](https://github.com/casey/just') is in A helper script, using [casey/just](https://github.com/casey/just') is in
[bin/cli](bin/cli). It can be used to quickly start an ephemeral (or [bin/cli](bin/cli). It can be used to quickly start an ephemeral (or
persistent) container. persistent) container.