From d2914892474d6a9d8d68a309a49a15ede0128ed2 Mon Sep 17 00:00:00 2001 From: Ryan D McGuire Date: Tue, 31 Dec 2024 21:37:26 -0500 Subject: [PATCH] Update README --- README.md | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d9102ec..879d094 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,36 @@ and shortcuts. This supports GitHub, GitLab, and Gitea remotes. +## Installation + +Install git-project-manager using `go`: +`go install -v gitea.libretechconsulting.com/rmcguire/git-project-manager@latest` + +OR Download a pre-built binary: +[https://gitea.libretechconsulting.com/rmcguire/-/packages/generic/git-project-manager](https://gitea.libretechconsulting.com/rmcguire/-/packages/generic/git-project-manager) + +## Setup + +**Generate a new config file:** +`git-project-manager config generate --write` + +**For handy aliases and shell helpers:** +- Download `https://gitea.libretechconsulting.com/rmcguire/git-project-manager/raw/branch/main/contrib/gpm_func_omz.zsh` +- Implement however you like (e.g. copy to ~/.oh-my-zsh/custom/) + +For just completion only, source completions from git-project-manager (e.g. for zsh, `source <(git-project-manager completion zsh)`) + +_The following commands assume you've loaded the gpm alias and help funcs._ + +**Index your git repos** +`gpm cache load` + +**Add your first project** +`padd` (gpm project add) + +**Go to your project, fuzzily** +`pgo` + ## Documentation [Full documentation is available in docs/](./docs/git-project-manager.md) @@ -40,15 +70,6 @@ The basic workflow looks like this: 1. **List** -- get a list of your configured projects any time with `plist` 1. **Reward** -- buy the author a beer, because this thing is a time saver -## Installing - -1. Install into your go path by running `go install .` -1. Copy `contrib/gpm_func_omz.zsh` into your `~/.oh-my-zsh/custom/` path, or just source from your bashrc/zshrc -1. Generate config file: `gpm config gen --write` - 1. You can run this any time to update settings - 1. It will only add one Git remote, so update the file for multiple -1. Run `gpm cache load` (if aliases is in-place, otherwise `git-project-manager cache load`) - ### Config Sample ```yaml remotes: