diff --git a/README.md b/README.md index c522cb7..19db0e0 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,9 @@

CodeSpy

-

- Automated code reviews for teams who care about correctness. -

An open-source AI reviewer that catches bugs, improves code quality, and integrates directly into your PR workflow, without sacrificing control or security.

-

- "Fast feedback. No black box. No vendor lock-in." -

@@ -31,6 +25,37 @@ --- +## Table of Contents + +- [Why CodeSpy?](#why-codespy) +- [Features](#features) +- [Installation](#installation) + - [Using pip](#using-pip) + - [Using Homebrew (macOS/Linux)](#using-homebrew-macoslinux) + - [Using Docker](#using-docker) + - [Using Poetry (for development)](#using-poetry-for-development) +- [Quick Start](#quick-start) +- [Usage](#usage) + - [Command Line](#command-line) + - [Using Docker](#using-docker-1) + - [GitHub Action](#github-action) +- [Configuration](#configuration) + - [Setup](#setup) + - [Git Platform Tokens](#git-platform-tokens) + - [LLM Provider](#llm-provider) + - [Advanced Configuration (YAML)](#advanced-configuration-yaml) + - [Recommended Model Strategy](#recommended-model-strategy) +- [Output](#output) + - [Markdown (default)](#markdown-default) + - [GitHub/GitLab Review Comments](#githubgitlab-review-comments) +- [Architecture](#architecture) +- [DSPy Signatures](#dspy-signatures) +- [Supported Languages](#supported-languages) +- [Development](#development) +- [License](#license) + +--- + ## Why CodeSpy? Most AI code reviewers are: