Skip to content

Commit

Permalink
chore: added warnings to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Eddie Knight <[email protected]>
  • Loading branch information
eddie-knight committed Jan 1, 2025
1 parent 791ef47 commit c0f7852
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit c0f7852

Please sign in to comment.