From 47555a02ed4ba78c0d3783ef0f14c37b401f0b41 Mon Sep 17 00:00:00 2001 From: Ross Turk Date: Tue, 11 Aug 2020 07:07:55 -0400 Subject: [PATCH] Add beta warning and todos (#136) * Add future ideas + beta warning to README Signed-off-by: Ross Turk * Update link Signed-off-by: Ross Turk --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 77a1b7878b4..2565d336a9d 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ A CLI tool and go library for generating a Software Bill of Materials (SBOM) fro - Supports packages and libraries from various ecosystems (APK, DEB, RPM, Ruby Bundles, Python Wheel/Egg/requirements.txt, JavaScript NPM/Yarn, Java JAR/EAR/WAR, Jenkins plugins JPI/HPI, Go modules) - OS distribution detection (supports alpine, busybox, centos/redhat, debian/ubuntu flavored distributions) +> :warning: **This is pre-release software** and it may not work as expected. If you encounter an issue, please [let us know using the issue tracker](https://github.com/anchore/syft/issues). + ## Getting started To generate an SBOM for an image: @@ -99,3 +101,9 @@ log: # enable/disable checking for application updates on startup check-for-app-update: true ``` + +## Future plans + +The following areas of potential development are currently being investigated: +- Add CycloneDX to list of output formats +- Establish a stable interchange format w/Grype