From 011d3cb6367f9f5e43046d864174bcfbfd205e71 Mon Sep 17 00:00:00 2001 From: Triston Armstrong Date: Mon, 13 Jan 2025 12:53:09 -0500 Subject: [PATCH] "feat(README): Add instructions for using ferro from within a git repo" --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index b083e25..880640f 100755 --- a/README.md +++ b/README.md @@ -65,4 +65,23 @@ graph { flow: east; } [interactive] { origin: arg parser; offset: 0,-2; } <== no args ==> {start:right; end:left}[arg parser] ~~~ ``` +--- + +# How to use +from within a git repo you can do the following + +## commit +*ensure you have staged files* +```bash +ferro -c +# or if you want to blindly accept what it spits out (fire and forget) +git commit -m $(ferro -c) + +``` + +## pull request +*this just generates the contents for you to populate a PR with* +```bash +ferro -p +```