Merge pull request #9 from ossf/chore/warning

chore: added warnings to docs
ossf · Jan 1, 2025 · a899029 · a899029
2 parents 791ef47 + c0f7852
commit a899029
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
 # Security Insights Tools
 
-A list of tools and scripts provided by Open Source Security Foundation and its community to validate, generate, and read `SECURITY-INSIGHTS.yml` files.
+A list of tools and scripts provided by Open Source Security Foundation and its community to validate, generate, and read Security Insights files.
+
+> [!WARNING]
+> These tools are _experimental only_ until an official release artifact is made.
diff --git a/python/README.md b/python/README.md
@@ -1,5 +1,10 @@
 # Command-line Generator and Validator
 
+> [!WARNING]
+> This was designed as part of the v1 release, and does not have any feature support for v2.
+>
+> The recommended method for validating v2 is to use the Cue schema included in the release.
+
 A Python command-line tool to help maintainters, developers, and contributors to generate or validate the SECURITY INSIGHTS yaml file.
 
 ## Usage