Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xynydev committed Sep 22, 2024
1 parent fc25813 commit 6400dde
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# [Nushell](https://www.nushell.sh/) image

This repository builds plain OCI images from the [Nushell's GitHub releases](https://github.com/nushell/nushell/releases).

## Details

- The images are built once per week on Sunday from the `x86_64-unknown-linux-gnu` version.
- Every image is tagged with the corresponding Nushell version, but the latest version also gets the `latest` tag (beware of breaking changes).
- Each image includes the full contents of the release `.tar.gz` in the `/nu/` directory.
- The images are built with a Nushell script: [`build.nu`](./build.nu).
- The images are signed with Sigstore's [cosign](https://github.com/sigstore/cosign) and can be verified with `cosign verify --key cosign.pub ghcr.io/blue-build/nushell-image`.

## How to use

```containerfile
FROM ghcr.io/blue-build/nushell-image:0.98.0 as nushell

FROM fedora:40

COPY --from=nushell /nu/nu /usr/bin/nu

RUN nu --version && nu -c "ls | sort-by size"
```

0 comments on commit 6400dde

Please sign in to comment.