From 150c1560f67706bb892901d0f186c52a623355b6 Mon Sep 17 00:00:00 2001 From: Sean Meininger Date: Mon, 10 Oct 2022 15:44:36 -0700 Subject: [PATCH] add installation placeholder docs --- README.md | 8 ++++++++ ok | 0 package.json | 6 ++---- 3 files changed, 10 insertions(+), 4 deletions(-) delete mode 100644 ok diff --git a/README.md b/README.md index 142c94a..aef1ac5 100644 --- a/README.md +++ b/README.md @@ -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. +## 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: Checks the CURRENT DIRECTORY recursively(via vsCode's [ripgrep package](https://github.com/microsoft/vscode-ripgrep)) diff --git a/ok b/ok deleted file mode 100644 index e69de29..0000000 diff --git a/package.json b/package.json index b4d89e8..f17b5b9 100644 --- a/package.json +++ b/package.json @@ -14,11 +14,9 @@ }, "scripts": { "start": "ts-node ./src/main.ts", - "build": "tsc" - }, - "dependencies": { + "build": "tsc -p ." }, "bin": { - "stotem" : "./dist/main.js" + "stotem": "./dist/main.js" } }