Skip to content

Commit 2e238d4

Browse files
authored
Revise SECURITY.md with overview and data storage info
Updated the security policy to include an overview, data storage details, and a responsible disclosure section.
1 parent 313b5ad commit 2e238d4

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policy
2+
3+
## Overview
4+
5+
Study Tracker is a **client-side only** HTML application. It runs entirely in your browser with no server, no database, and no user accounts.
6+
7+
## What Data is Stored
8+
9+
| Data | Where | Notes |
10+
|------|-------|-------|
11+
| Chapter progress | Browser `localStorage` | Stays on your device only |
12+
| AI API keys | Browser `localStorage` | Stays on your device only |
13+
| Chat history | Browser memory (RAM) | Cleared when you close the tab |
14+
15+
**No data is ever sent to our servers** because there are no servers. Your API keys go directly from your browser to the AI provider (Google, Groq, etc.).
16+
17+
## Reporting a Vulnerability
18+
19+
If you find a security issue (e.g. XSS vulnerability, API key exposure risk), please:
20+
21+
1. **Do NOT open a public issue**
22+
2. Contact the maintainer directly by opening a **private** issue or reaching out via the social links in the README
23+
24+
Please include:
25+
- Description of the vulnerability
26+
- Steps to reproduce
27+
- Potential impact
28+
29+
We'll respond within 72 hours and credit you in the fix.
30+
31+
## Supported Versions
32+
33+
| Version | Supported |
34+
|---------|-----------|
35+
| Latest | ✅ Yes |
36+
| Older | ❌ Please update to latest |
37+
38+
## Responsible Disclosure
39+
40+
We appreciate responsible disclosure. Please give us a reasonable amount of time to fix the issue before making it public.

0 commit comments

Comments
 (0)