Skip to content

Latest commit

 

History

History
59 lines (50 loc) · 2.84 KB

README.md

File metadata and controls

59 lines (50 loc) · 2.84 KB

Documentation

Everything below assumes you've already done the README quick start. If you only read one page here, make it the threat model, especially before you put the dashboard on your LAN.

Start here

Getting started

Operating the SDK

Inspectors

Security

Design

Reference

  • Protocol reference — the embedded server's REST/WebSocket wire protocol
  • API reference is generated from source via Dokka, not hand-written (hand-written prose would drift out of sync with the code). Run ./gradlew dokkaGenerate and open build/dokka/html/index.html. Covers sdk:api — the module with a committed public API surface (see the root apiValidation block).

Contributing / releasing