From 2dcf0a40b936ea4699f7ffec6832463aef586b9a Mon Sep 17 00:00:00 2001 From: david Date: Tue, 19 Dec 2023 09:42:59 +0100 Subject: [PATCH] updated README.md --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d30f1cc..63ad71b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ -# wg-vanity-address-docker +# wgvanity-container -This image is based on Archlinux and is used to generate Wireguard keys. +Multi-arch Docker image for [wireguard-vanity-address](https://github.com/warner/wireguard-vanity-address). The image is based off of `alpine:latest`. -## Usage example +## Usage -```bash -git clone https://git.socialnerds.org/socialnerds/wg-vanity-address-docker.git -cd wg-vanity-address-docker -docker build . --tag socialnerds/wg-vanity-address:latest -docker run --rm -it socialnerds/wg-vanity-address:latest --in 6 dave - -#or - -docker run --rm -it socialnerds/wg-vanity-address:latest --in 6 dave ``` +docker run --rm -it git.socialnerds.org/david/wgvanity-container:latest dave +``` + +``` +docker run --rm -it git.socialnerds.org/david/wgvanity-container:latest --in 4 dave +``` + +For more information check out the documentation of the [wireguard-vanity-address project on Github](https://github.com/warner/wireguard-vanity-address).