Skip to content

Commit fd325a6

Browse files
committed
docs: update shell/README.md
1 parent 2a8b112 commit fd325a6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

shell/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Shell
22

3-
Bash scripts around this project.
3+
Bash scripts around this project, to be used instead of as a VS Code extension. **This area is not complete and is still experimental.**
44

5-
All the scripts in this directory are named with dashes and not underscores, to match the Git hook filenames convention.
5+
Note: All the scripts in this directory are named with dashes and not underscores, to match the Git hook filenames convention.
66

77

88
## Samples
@@ -56,10 +56,10 @@ $ cp autofill.sh /usr/local/bin
5656

5757
TODO:
5858

59-
- [] Where to put the Node script so it can reference it.
60-
- [] Windows support
61-
- [] How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install.
62-
- [] 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.
59+
- [ ] Where to put the Node script so it can reference it.
60+
- [ ] Windows support
61+
- [ ] How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install.
62+
- [ ] 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.
6363

6464
#### Alias
6565

@@ -80,9 +80,9 @@ $ git c foo.txt
8080

8181
#### TODO
8282

83-
- [] For now this points to the output directory so it limited in real world use. This is a stepping
83+
- [ ] For now this points to the output directory so it limited in real world use. This is a stepping
8484
stone. But ideally the JS files can be copied outside of this project to a central location (maybe
8585
with a `bin` entry point). And the SH script can be added to an individual project in `.git/hooks` dir as `prepare-commit-msg`.
86-
- [] When using this as a hook, consider reading from the **existing** commit message file in the case
86+
- [ ] When using this as a hook, consider reading from the **existing** commit message file in the case
8787
of template, so it that can be passed on.
88-
- [] Add a flag for staged to get `--cached` flag.
88+
- [ ] Add a flag for staged to get `--cached` flag.

0 commit comments

Comments
 (0)