rmcguire/git-project-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ryan McGuire 2023-12-10 11:43:31 -05:00
parent 43342bf858
commit 59962a01aa
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -18,21 +18,21 @@ gpm know that and it'll remember.
The basic workflow looks like this: The basic workflow looks like this:
1. **Cache** -- load your cache to make things super quick 1. **Cache** -- load your cache to make things super quick
- project cache has a TTL, or you can load it manually 1. project cache has a TTL, or you can load it manually
- you only need to update it if there are new projects the cache is unaware of 1. you only need to update it if there are new projects the cache is unaware of
2. **Add** -- find your project, give it any extra aliases you want 1. **Add** -- find your project, give it any extra aliases you want
- run `gpm project add` (or `padd` if using the provided shell defaults) 1. run `gpm project add` (or `padd` if using the provided shell defaults)
3. **Go** -- go to your project, fuzzy searching by alias 1. **Go** -- go to your project, fuzzy searching by alias
- clones your project if that's never been done 1. clones your project if that's never been done
- the provided `pgo` func makes it easy 1. the provided `pgo` func makes it easy
4. **Open** -- rather than simply changing directories to a project, open it in your IDE 1. **Open** -- rather than simply changing directories to a project, open it in your IDE
5. **Manage** -- fine-tune your aliases, making it easy to nail them without fuzzy stuff 1. **Manage** -- fine-tune your aliases, making it easy to nail them without fuzzy stuff
- if you are lazy in your aliases, you'll be fuzzy finding a lot 1. if you are lazy in your aliases, you'll be fuzzy finding a lot
- match your alias exactly (or have only one result) and you go there right away 1. match your alias exactly (or have only one result) and you go there right away
- positive reinforcement given for solid alias behavior 1. positive reinforcement given for solid alias behavior
- manage aliases using `gpm alias add` or `gpm alias delete` 1. manage aliases using `gpm alias add` or `gpm alias delete`
6. **List** -- get a list of your configured projects any time with `plist` 1. **List** -- get a list of your configured projects any time with `plist`
7. **Reward** -- buy the author a beer, because this thing is a time saver 1. **Reward** -- buy the author a beer, because this thing is a time saver
## TODO ## TODO