From 51600d272e7a4f256510b0040d96b2647a6cfc65 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Thu, 14 Nov 2024 11:13:14 +0100 Subject: [PATCH] chore: document that we still expect to make API changes 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, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7aadd0..fceb8a4 100644 --- a/README.md +++ b/README.md @@ -60,9 +60,11 @@ lazy val root = (project in file(".")) ) ``` -## CycloneDX support +## Stability -Actually, only version 1.0 of the CycloneDX specification is supported. Support for later versions of the specification, such as for creating BOMs in json format, is expected later. +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