add installation placeholder docs
This commit is contained in:
parent
98fe8fb837
commit
150c1560f6
|
@ -2,6 +2,14 @@ This tool aims to simplify setting up local reproduction environments for writin
|
||||||
|
|
||||||
At present, navigate to your sentinel policy directory (containing the .hcl) and run `main.js` there.
|
At present, navigate to your sentinel policy directory (containing the .hcl) and run `main.js` there.
|
||||||
|
|
||||||
|
## Build instructions:
|
||||||
|
### TODO: Remediate required double install. Probably because I'm using `nvm`
|
||||||
|
### TODO: Fix uninstall
|
||||||
|
|
||||||
|
Clone the directory locally, then navigate to that directory and run `npm install`.
|
||||||
|
Next, run `npm run build`
|
||||||
|
Finally, run `npm install -g` if you want `stotem` in your path
|
||||||
|
|
||||||
## Current functionality:
|
## Current functionality:
|
||||||
|
|
||||||
Checks the CURRENT DIRECTORY recursively(via vsCode's [ripgrep package](https://github.com/microsoft/vscode-ripgrep))
|
Checks the CURRENT DIRECTORY recursively(via vsCode's [ripgrep package](https://github.com/microsoft/vscode-ripgrep))
|
||||||
|
|
|
@ -14,9 +14,7 @@
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "ts-node ./src/main.ts",
|
"start": "ts-node ./src/main.ts",
|
||||||
"build": "tsc"
|
"build": "tsc -p ."
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
},
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"stotem": "./dist/main.js"
|
"stotem": "./dist/main.js"
|
||||||
|
|
Loading…
Reference in a new issue