From 97c079e959e0c2e59b27598a84d8e34cadd9f952 Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Sun, 3 Nov 2024 19:37:25 +0100 Subject: [PATCH] docs: update shell/README.md --- shell/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/shell/README.md b/shell/README.md index c66d65b..6f55a3e 100644 --- a/shell/README.md +++ b/shell/README.md @@ -56,9 +56,10 @@ $ cp autofill.sh /usr/local/bin TODO: -- Where to put the Node script so it can reference it. -- How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install. -- Figure out how to switch between staged and not, with `--cached`. Like passing a param to the shell script and having two aliases. Or to have it as pass of the shell script to fallback to all if anything is staged. Or just control with filenames e.g. `git c .` or `git c package*` - oh wait, the shell script doesn't look at what is passed to `git commit`, only what is staged or not. +- [] Where to put the Node script so it can reference it. +- [] Windows support +- [] How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install. +- [] Figure out how to switch between staged and not, with `--cached`. Like passing a param to the shell script and having two aliases. Or to have it as pass of the shell script to fallback to all if anything is staged. Or just control with filenames e.g. `git c .` or `git c package*` - oh wait, the shell script doesn't look at what is passed to `git commit`, only what is staged or not. #### Alias @@ -79,9 +80,9 @@ $ git c foo.txt #### TODO -- For now this points to the output directory so it limited in real world use. This is a stepping +- [] For now this points to the output directory so it limited in real world use. This is a stepping stone. But ideally the JS files can be copied outside of this project to a central location (maybe with a `bin` entry point). And the SH script can be added to an individual project in `.git/hooks` dir as `prepare-commit-msg`. -- When using this as a hook, consider reading from the **existing** commit message file in the case +- [] When using this as a hook, consider reading from the **existing** commit message file in the case of template, so it that can be passed on. -- Add a flag for staged to get `--cached` flag. +- [] Add a flag for staged to get `--cached` flag.