Skip to content

docs: write README in maintainer voice #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Labeeb2339 merged 1 commit into from
Jul 22, 2026
Merged

docs: write README in maintainer voice #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

**A fully local cybersecurity RAG prototype with hybrid retrieval, MITRE ATT&CK graph grounding, cited answers, and a repeatable evaluation harness.**

CyberRAG explores a practical question: how much can retrieval improve a small local model on threat-intelligence tasks while keeping query-time data on the user's machine?
I built CyberRAG to explore a practical question: how much can retrieval improve
a small local model on threat-intelligence tasks while keeping query-time data
on the user's machine?

The project was built in response to a CyberSecurity Malaysia challenge brief. It is an independent prototype, not an official commission, deployment, or endorsed CyberSecurity Malaysia product.
I began the project in response to a CyberSecurity Malaysia challenge brief. It
is an independent prototype, not an official commission, deployment, or endorsed
CyberSecurity Malaysia product.

## What it demonstrates

Expand Down
Loading