Updated readme, added npmignore
This commit is contained in:
1
.npmignore
Normal file
1
.npmignore
Normal file
@@ -0,0 +1 @@
|
|||||||
|
package-lock.json
|
||||||
13
readme.md
13
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
|
## Global Installation
|
||||||
|
|
||||||
### HTTP
|
### HTTPS
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
sudo npm install -g 'git+https://gitea.efforting.tech/mikael-lovqvist/shell-utils.git#latest'
|
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
|
### 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
|
```sh
|
||||||
sudo npm install -g 'git+ssh://git.efforting.tech:mikael-lovqvist/shell-utils.git#latest'
|
sudo npm install -g 'git+ssh://git.efforting.tech:mikael-lovqvist/shell-utils.git#latest'
|
||||||
```
|
```
|
||||||
Reference in New Issue
Block a user