Skip to content

Commit 497a03c

Browse files
committed
Added installation-section in README
1 parent bfc6a94 commit 497a03c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,38 @@ sequenceDiagram
5050
LLM (Cloud)-->>AIgis (Browser): Returns Answer ("Email for [EMAIL_1]...")
5151
Note over AIgis (Browser): 5. Reverse PII-Mapping and TOON <br/>Replace [EMAIL_1] / TOON -> foo@bar.com / JSON
5252
AIgis (Browser)-->>User: Displays Final Answer
53+
```
54+
55+
---
56+
57+
## Installation
58+
59+
AIgis is currently in **active development** and not yet listed on the Chrome Web Store. You can install it manually in less than a minute:
60+
61+
1. **Download:** Go to the [Releases Page](../../releases) and download the latest `AIgis-vX.X.X.zip` (found under "Assets").
62+
2. **Unzip:** Extract the ZIP file into a folder of your choice.
63+
3. **Open Chrome Extensions:** Navigate to `chrome://extensions/` in your browser.
64+
4. **Enable Developer Mode:** Toggle the switch **"Developer mode"** in the top-right corner.
65+
5. **Load Extension:** Click the **"Load unpacked"** button (top left).
66+
6. **Select:** Select the folder you just extracted.
67+
68+
**Ready!** AIgis is now active. We recommend pinning the extension icon to your toolbar for quick access to the toggle switch.
69+
70+
> **Security Note:** Every release includes a `.sha256` checksum file. You can verify the integrity of the downloaded ZIP against this hash to ensure the file hasn't been tampered with.
71+
72+
### For Developers (Build from Source)
73+
74+
If you want to contribute or audit the code:
75+
76+
```bash
77+
# 1. Clone the repo
78+
git clone https://github.com/Karaatin/AIgis.git
79+
80+
# 2. Install dependencies
81+
npm install
82+
83+
# 3. Build the project
84+
npm run build
85+
86+
# 4. Load the 'dist' folder in Chrome (via "Load unpacked")
87+
```

0 commit comments

Comments
 (0)