add installation placeholder docs

This commit is contained in:
Sean Meininger 2022-10-10 15:44:36 -07:00
parent 98fe8fb837
commit 150c1560f6
3 changed files with 10 additions and 4 deletions

View file

@ -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))

0
ok
View file

View file

@ -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"