From a29670ca77cf33e27039c96f45f8ba759d74fc33 Mon Sep 17 00:00:00 2001 From: Daniel Alejandro Gallegos Date: Sun, 12 Nov 2023 19:52:43 -0500 Subject: [PATCH] feat: add instructions on how to run this thing --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 907e1f9..0e29694 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,20 @@ A CLI app that prints a random [Strong Bad Email](http://www.hrwiki.org/wiki/Strong_Bad_Email), written in Rust. +## Install +You will need rustc/cargo installed. Then, install the package from Codeberg: + +``` +cargo install strongbad_email --git https://codeberg.org/takouhai/strongbad_email.git +``` + +then just run + +``` +strongbad_email +``` +and you should be good to go. ## License