"feat(README): Add instructions for using ferro from within a git repo"

This commit is contained in:
Triston Armstrong 2025-01-13 12:53:09 -05:00
parent 1cf6d12bd6
commit 011d3cb636
Signed by: tristonarmstrong
GPG Key ID: A23B48AE45EB6EFE

View File

@ -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
```