Skip to content

docs: v0.1.0#11

Merged
krakenhavoc merged 1 commit intomainfrom
docs/v0.1.0
Mar 27, 2026
Merged

docs: v0.1.0#11
krakenhavoc merged 1 commit intomainfrom
docs/v0.1.0

Conversation

@krakenhavoc
Copy link
Copy Markdown
Contributor

This pull request adds essential project documentation and clarifies the configuration and operating modes of the KrakenKey Probe. It introduces a changelog, contribution and security guidelines, and significantly expands the README.md to better explain usage, deployment, and operational details. The .env.example file is updated to reflect the new supported modes.

Key documentation and configuration improvements:

Project documentation:

  • Added CHANGELOG.md following Keep a Changelog and Semantic Versioning to record all notable changes and initial features.
  • Added CONTRIBUTING.md with guidelines for setup, development workflow, code conventions, and issue reporting.
  • Added SECURITY.md outlining vulnerability reporting, supported versions, and security considerations for API keys, container, and network.

Configuration and usage clarification:

  • Updated .env.example to document the new hosted mode in addition to standalone and connected.
  • Major expansion and clarification of README.md:
    • Added detailed instructions and tables for the three operating modes (standalone, connected, hosted), including configuration precedence, environment variables, and API key requirements. [1] [2]
    • Improved Docker and Kubernetes deployment examples to reflect new modes and configuration options.
    • Clarified probe startup, scan, and shutdown behavior for each mode, and documented health check endpoints (/healthz, /readyz) with example responses. [1] [2]

@krakenhavoc krakenhavoc merged commit 999f0d3 into main Mar 27, 2026
9 checks passed
@krakenhavoc krakenhavoc deleted the docs/v0.1.0 branch March 27, 2026 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant