Revise README content and badge information#112
Conversation
Updated README to refine project description and remove redundant badges.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR refreshes the top-level README to better describe TrustSignal’s purpose, streamline onboarding instructions, and simplify badge/link presentation for readers evaluating the project.
Changes:
- Refines the project description and reorganizes sections (problem statement, how it works, API surface).
- Updates onboarding content (demo, local dev setup, verification curl examples) and adds a repository structure overview.
- Simplifies badges and adds a TypeScript version badge.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
The vulnerability reporting address was already updated to |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Endpoint | Purpose | | ||
| |---|---| | ||
| | `POST /api/v1/verify` | Submit a verification request | |
There was a problem hiding this comment.
The Markdown table header/rows start with ||, which creates an unintended empty first column and can render the table incorrectly. Use a single leading/trailing | per row (e.g., | Endpoint | Purpose |).
| | Layer | Technology | | ||
| |---|---| | ||
| | API Server | TypeScript, Fastify v5, Prisma ORM | | ||
| | Database | PostgreSQL | |
There was a problem hiding this comment.
This Tech Stack table uses || at the start of each row, which introduces an empty first column and breaks expected Markdown table formatting. Replace the double leading pipes with a single | consistently across the table.
| | Layer | What Stays in Place | | ||
| |---|---| | ||
| | Evidence collection | Your platform (Vanta, Drata, internal collector) | | ||
| | System of record | Unchanged | |
There was a problem hiding this comment.
The Integration Fit table rows begin with ||, which adds an extra empty column and may render misaligned in Markdown viewers. Adjust the table rows to use a single leading |.
| | Resource | Path | | ||
| |---|---| | ||
| | Partner Evaluation Kit | [docs/partner-eval/overview.md](docs/partner-eval/overview.md) | | ||
| | Evaluator Quickstart | [docs/partner-eval/quickstart.md](docs/partner-eval/quickstart.md) | |
There was a problem hiding this comment.
The Documentation table is formatted with || at the start of each row, creating an unintended blank column. Use standard Markdown table syntax with single leading/trailing pipes so the table renders as two columns.
| | Repository | Purpose | | ||
| |---|---| | ||
| | [v0-signal-new](https://github.com/TrustSignal-dev/v0-signal-new) | Public website — trustsignal.dev | | ||
| | [TrustSignal-App](https://github.com/TrustSignal-dev/TrustSignal-App) | GitHub App for CI verification | |
There was a problem hiding this comment.
The Ecosystem table rows start with ||, which results in an extra empty column and can break table rendering. Use standard Markdown table formatting (single leading |) for the header and all rows.
Updated README to refine project description and remove redundant badges.
Summary
AI Disclosure (optional)
Review Checklist