From 61842e61b16716a00a6e4baa650f2b15b85c80fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikael=20L=C3=B6vqvist?= Date: Sun, 22 Feb 2026 04:20:02 +0100 Subject: [PATCH] Updated readme, added npmignore --- .npmignore | 1 + readme.md | 13 ++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 .npmignore diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..483a9c4 --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +package-lock.json \ No newline at end of file diff --git a/readme.md b/readme.md index 60e9638..d3c41dd 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,13 @@ +## Usage + +*Here is an example for `jg` (javascript grep):* +```sh +grep --color=always -rin "$@" --include "*.js" --include "*.mjs" --exclude "*.min.js" --exclude-dir node_modules | grep-mtime-sorter | ansi-trunc -l 250 +``` + ## Global Installation -### HTTP +### HTTPS ```sh sudo npm install -g 'git+https://gitea.efforting.tech/mikael-lovqvist/shell-utils.git#latest' @@ -8,6 +15,10 @@ sudo npm install -g 'git+https://gitea.efforting.tech/mikael-lovqvist/shell-util ### SSH +> [!CAUTION] +> When you run `npm` as sudo, it will not use your users git configuration or identity. For now HTTPS is recommended instead. + + ```sh sudo npm install -g 'git+ssh://git.efforting.tech:mikael-lovqvist/shell-utils.git#latest' ``` \ No newline at end of file