API Documentation

This section provides documentation for the public API surface of Termdash. You can also refer to the generated godoc.

Not all packages in this repository are public. Private packages can be identified by the presence of the /internal/ directory in their import path. Stability of the private packages isn't guaranteed and changes won't be backward compatible.

API Maturity

There might still be breaking changes to the public API, at least until the project reaches version 1.0.0. Any breaking changes will be published in the changelog.

See a typo, something missing or outright wrong? Feel free to edit the Wiki pages directly, alternatively talk to us.