Skip to content

Commit

Permalink
docs: add the link to the demo (#596)
Browse files Browse the repository at this point in the history
Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>
  • Loading branch information
behnazh-w authored Jan 10, 2024
1 parent 7ea4e2e commit 62a4813
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/source/pages/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.youtube.com/watch?v=ebo0kGKP6bw>`_ the demo of this tutorial.

The example project we analyze in this tutorial is `example-maven-app <https://github.com/behnazh-w/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 <https://github.com/behnazh-w/example-maven-app>`_,
which is hosted on GitHub. This example application uses Maven to build and manage dependencies, and has two
dependencies:

Expand Down

0 comments on commit 62a4813

Please sign in to comment.