From 2fcfe9dd6daf15d116d602666d49457f8a109905 Mon Sep 17 00:00:00 2001 From: siph Date: Sat, 8 Oct 2022 19:19:26 -0600 Subject: [PATCH] docs: add nix instructions Oxker has been merged into nixpkgs. This commit adds instructions for using oxker with nix. This also reworks the 'Run & Install' section to be more cohesive. --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ca3486f..9e01176 100644 --- a/README.md +++ b/README.md @@ -14,20 +14,30 @@

-## Run via Docker - -Published on Docker Hub, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6` - -`docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker` - ## Download & install +### Cargo Published on crates.io, so if you have cargo installed, simply run ```cargo install oxker``` -else see the pre-built binaries +### Docker +Published on Docker Hub, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6` + +`docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker` + +### Nix +Using nix flakes, oxker can be ran directly with + +```nix run nixpkgs#oxker``` + +Without flakes, you can build a shell that contains oxker using + +```nix-shell -p oxker``` + +### Pre-Built +See the pre-built binaries or, download & install (x86_64 one liner) @@ -110,4 +120,4 @@ or individually ```docker run --name postgres -e POSTGRES_PASSWORD=never_use_this_password_in_production -d postgres:alpine3.16``` -```docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3``` \ No newline at end of file +```docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3```