docs: comprehensive documentation update

Update README with detailed project overview, features, installation, and usage. Add AGENTS.md developer guide, CONTRIBUTING.md guidelines, MIT LICENSE file, and fix CI workflow configuration.
2026-02-12 10:51:37 -05:00
parent 776188bb5b
commit 7323a6f7a8
6 changed files with 452 additions and 42 deletions
@@ -1 +1,34 @@
-name: CI & Lighthouse\non:\n  push:\n  pull_request:\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: Setup Node\n        uses: actions/setup-node@v4\n        with:\n          node-version: '20'\n      - name: Install deps\n        run: npm ci\n      - name: Build\n        run: npm run build\n      - name: Lighthouse\n        uses: lighthouse-checker/action@v1\n        with:\n          urls: |\n            http://localhost:8080/index.html\n          prComment: true
+name: CI & Lighthouse
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          
+      - name: Install dependencies
+        run: npm ci
+        
+      - name: Build project
+        run: npm run build
+        
+      - name: Run Lighthouse audit
+        uses: lighthouse-checker/action@v1
+        with:
+          urls: |
+            http://localhost:8080/
+          prComment: true
+          serverCommand: 'npm run preview -- --port 8080'
+          waitForServer: true