Merge pull request #2 from slauth-io/improve-readme

fix(docs): improve readme

README.md

@@ -1,11 +1,17 @@
-# slauth-cli
+# Slauth.io
 
 CLI that scans repositories and generates the necessary IAM Policies for the service to run.
 
+## Installation
+
+```bash
+npm install -g @slauth.io/slauth
+```
+
 ## Usage
 
-1. set the `OPENAI_API_KEY` environment variable: `export OPENAI_API_KEY=<key>`
-2. run `slauth --help` to see available commands
+1. Set the `OPENAI_API_KEY` environment variable: `export OPENAI_API_KEY=<key>`
+2. Run `slauth --help` to see available commands
 
 ### Example scan command
 
@@ -17,8 +23,8 @@ slauth scan -p aws ./path/to/my/repository
 
 ## Development
 
-1. set your `OPENAI_API_KEY` in the `.env` file at the root of the project
-2. run `npm i`
-3. install the `slauth` CLI globally: `npm install -g .`
-4. compile tsc on file change: `npm run build-watch`
-5. test it, `slauth -h` should work
+1. Set your `OPENAI_API_KEY` in the `.env` file at the root of the project
+2. Run `npm i`
+3. Install the `slauth` CLI globally: `npm install -g .`
+4. Compile tsc on file change: `npm run build-watch`
+5. Test it, `slauth -h` should work

package.json

@@ -16,9 +16,8 @@
     "format": "prettier ./src --write",
     "format-check": "prettier ./src --check"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "keywords": ["cli", "aws", "iam", "policies", "llm", "openai"],
+  "license": "MIT",
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^6.10.0",
     "@typescript-eslint/parser": "^6.10.0",