Skip to content

Expand README with project overview and status badges#37

Merged
toddysm merged 2 commits into
mainfrom
feat/readme-overview
Jun 3, 2026
Merged

Expand README with project overview and status badges#37
toddysm merged 2 commits into
mainfrom
feat/readme-overview

Conversation

@toddysm

@toddysm toddysm commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Rewrites the repository README to better explain its purpose and direction.

  • Describes the repo as a demonstration of the CSSC framework and the Custos project.
  • Documents the three current sample apps (Python, Node.js, Java) and supporting supply chain capabilities.
  • Adds a 'What's coming next' section noting future AI-related artifacts (models, datasets) and how they will be secured.
  • Adds a repository layout table and links to the detailed docs under docs/.
  • Adds issue/PR/license status badges at the top.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR rewrites the repository README to provide a clearer project description, document current sample apps, and add navigation/metadata (badges, repo layout, doc links) so new contributors can quickly understand what the repo contains and where to find details.

Changes:

  • Adds GitHub issues/PR/license badges and expands the intro/overview content.
  • Documents the three sample applications and existing supply-chain-related workflows/conventions.
  • Adds sections for “What’s coming next”, repo layout, and pointers into docs/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@toddysm toddysm merged commit ca83107 into main Jun 3, 2026
@toddysm toddysm deleted the feat/readme-overview branch June 3, 2026 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants