Skip to content

Commit 373e8d5

Browse files
committed
Minor README updates
1 parent b715da6 commit 373e8d5

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,33 @@
33
## Overview
44

55
The `demo-repo-rust` project is a repository template primarily intended for testing and
6-
demonstration purposes with stacklok projects. It is a simple Python project that allows you to
6+
demonstration purposes with Stacklok projects. It is a simple Rust project that allows you to
77
quickly get started with testing and demonstrating how you can use Minder and Trusty with
8-
your Python projects. It features continuous integration (CI) workflows that demonstrate how to
8+
your Rust projects. It features continuous integration (CI) workflows that demonstrate how to
99
build, test, and sign artifacts using Sigstore and GitHub Attestations.
1010

11-
1211
## Features
1312

1413
- Pre-configured `Cargo.toml`
1514
- Sample Rust code in `src/main.rs`
1615
- Dockerfile for building a container image
1716

1817
GitHub Actions workflows for:
18+
1919
- Producing signed and unsigned artifacts using Sigstore and GitHub attestations API
2020
- Producing artifacts such as container images and binaries
2121
- Producing container images that are reproducible (always the same digest)
2222
- Producing "malicious" container images for testing purposes (e.g., code content was altered while building the image)
2323

2424
Makefile targets for simulating out-of-band signing of artifacts (both intended and not):
25+
2526
- Generating signed container images and "malicious" images
2627
- Pushing container images to container registry (GHCR)
2728
- Generating a local key pair for signing container images
2829
- Sign container images using Sigstore by using a local key pair or by going through the Sigstore OIDC sign-in flow
2930

3031
Branches:
32+
3133
- Set of pre-created branches to use for opening PRs each demonstrating a different feature or use case with Minder and Trusty
3234

3335
## How to Use This Template

0 commit comments

Comments
 (0)