From 77eb2a810a090940f915dd6ea86da2a9597763cd Mon Sep 17 00:00:00 2001 From: Marc Cataford Date: Sat, 2 Nov 2024 15:19:37 -0400 Subject: [PATCH] docs: add readme stub --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5fb78a..d3f6af9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # forge-tools -Like `gh` and `tea`, but aspiring to be compatible with multiple forge types to avoid using different tools for each. \ No newline at end of file +Like `gh` and `tea`, but aspiring to be compatible with multiple forge types to avoid using different tools for each. + +## Usage + +`frg --help` will give you an overview of what's available! + +## Development + +This uses `uv` to manage dependencies; [make sure it's installed before proceeding](https://github.com/astral-sh/uv). + +### Direction + +The primary intention of this is to make a more hackable version of `gh`-like tooling for my own purposes. This is not aiming feature parity or production-level quality.