From c7b2ae0f644bf5f436d32ddc278ea831783e7cc1 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Wed, 8 Jan 2025 17:28:39 +0100 Subject: [PATCH] chore: document that we still expect to make API changes (#92) We'll likely want to refactor the task structure when we implement #89, #90 or #91, it might be nice to explicitly set expectations around this without making it a blocker for doing earlier releases. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 86ef9c4..1e558f1 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,12 @@ lazy val root = (project in file(".")) This plugin supports the CycloneDX XML and JSON BOM formats. +## Stability + +We believe this plugin is stable enough to be used in production, but +we do not yet promise API stability: you may need to make configuration +changes or encounter changed behaviour when updating the plugin. + ## Contributing ### testing