Skip to content

Add citation metadata #9

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

Open
kernelpanic888 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add citation metadata #9

Show file tree
Hide file tree
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
22 changes: 22 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
cff-version: 1.2.0
message: "If you use Harbinger in research, please cite it as below."
type: software
title: "Harbinger: AI-powered log pre-classifier for Microsoft Sentinel"
abstract: "Observe-only profiler that classifies syslog events with a local Ollama model and produces a per-source tier recommendation report for Microsoft Sentinel cost optimisation."
authors:
- family-names: "Beard"
given-names: "Ben"
email: "ben@azurebeard.co.uk"
affiliation: "AzureBeard"
repository-code: "https://github.com/azurebeard/harbinger"
url: "https://azurebeard.co.uk"
license: Apache-2.0
version: "1.0.1"
date-released: "2026-06-22"
keywords:
- microsoft-sentinel
- siem
- log-classification
- ollama
- syslog
- cost-optimization
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ Permanently out of scope (with rationale in [`docs/roadmap.md`](docs/roadmap.md)
| Document | Purpose |
|---|---|
| [`README.md`](README.md) | You are here. |
| [`CITATION.cff`](CITATION.cff) | Machine-readable citation metadata for GitHub's Cite this repository widget. |
| [`docs/architecture.md`](docs/architecture.md) | Full runtime architecture, trust boundaries, failure modes, non-goals. |
| [`docs/schema.md`](docs/schema.md) | Public stability contract — JSON output, CLI, config file. |
| [`docs/sample-profile.json`](docs/sample-profile.json) | Complete realistic example of the JSON output. |
Expand Down