From 62a481369978bdbac87e00264b4658f7b7e4f4e6 Mon Sep 17 00:00:00 2001 From: Behnaz Hassanshahi Date: Wed, 10 Jan 2024 12:27:04 +1000 Subject: [PATCH] docs: add the link to the demo (#596) Signed-off-by: behnazh-w --- README.md | 4 +++- docs/source/pages/tutorials/index.rst | 9 +++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5f13fa69c..475dffec6 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,9 @@ To see the full list of supported technologies, such as CI services, registries, ## Getting started -To learn how to download and run Macaron, see our documentation [here](https://oracle.github.io/macaron/). +* To learn how to download and run Macaron, see our documentation [here](https://oracle.github.io/macaron/). +* Check out our [tutorials](https://oracle.github.io/macaron/pages/tutorials/index.html) to see how Macaron can detect software supply chain issues. +* You can also watch [this demo](https://www.youtube.com/watch?v=ebo0kGKP6bw) to learn more about Macaron. ## Contributing diff --git a/docs/source/pages/tutorials/index.rst b/docs/source/pages/tutorials/index.rst index c07cd3365..61a68cd08 100644 --- a/docs/source/pages/tutorials/index.rst +++ b/docs/source/pages/tutorials/index.rst @@ -22,11 +22,12 @@ Detect a malicious Java dependency uploaded manually to Maven Central --------------------------------------------------------------------- In this tutorial we show how Macaron can determine whether the dependencies of a Java project are built -and published via transparent CI workflows or manually uploaded to Maven Central. When an artifact is -manually uploaded, the artifact distributor can modify the artifact and potentially include malicious -code without being detected. +and published via transparent CI workflows or manually uploaded to Maven Central. You can also +`watch `_ the demo of this tutorial. -The example project we analyze in this tutorial is `example-maven-app `_, +When an artifact is manually uploaded, the artifact distributor can modify the artifact and potentially +include malicious code without being detected. The example project we analyze in this tutorial is +`example-maven-app `_, which is hosted on GitHub. This example application uses Maven to build and manage dependencies, and has two dependencies: