diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..2bd5a0a --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +22 diff --git a/README.md b/README.md index 194014b..6ac251c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ **A full-stack website audit — technical SEO, LLM-readiness, and marketing effectiveness — in a single deterministic engine.** -![Trivium — open-source website audits for the AI-search era](media/trivium_demo.gif) + +![Trivium UI](docs/screenshot2.png) ▶ **[Watch the full promo video](media/trivium_promo_stable_silent.mp4)** @@ -41,32 +42,45 @@ ## Table of Contents -- [About](#about) -- [Why Trivium?](#why-trivium) -- [How It Compares](#how-it-compares) -- [The Three Pillars](#the-three-pillars) -- [Features](#features) -- [Quick Start](#quick-start) -- [Installation](#installation) -- [Configuration](#configuration) -- [Usage](#usage) -- [API Reference](#api-reference) -- [Scan Flow](#scan-flow) -- [Project Structure](#project-structure) -- [Tech Stack](#tech-stack) -- [Testing](#testing) -- [Deployment](#deployment) -- [Roadmap](#roadmap) -- [Contributing](#contributing) -- [FAQ](#faq) -- [Community & Support](#community--support) -- [Security](#security) -- [License](#license) -- [Commercial Use](#commercial-use) -- [Hosted Version](#hosted-version) -- [Contributors](#contributors) -- [Acknowledgements](#acknowledgements) -- [Maintainer](#maintainer) +- [Trivium](#trivium) + - [Table of Contents](#table-of-contents) + - [About](#about) + - [Why Trivium?](#why-trivium) + - [How It Compares](#how-it-compares) + - [The Three Pillars](#the-three-pillars) + - [🔧 Grammar — Technical SEO (29 checks)](#-grammar--technical-seo-29-checks) + - [🤖 Logic — LLM Readiness (19 checks)](#-logic--llm-readiness-19-checks) + - [🎯 Rhetoric — Marketing Effectiveness (20 checks)](#-rhetoric--marketing-effectiveness-20-checks) + - [Features](#features) + - [Quick Start](#quick-start) + - [Installation](#installation) + - [Prerequisites](#prerequisites) + - [Clone and install](#clone-and-install) + - [Run the dev servers](#run-the-dev-servers) + - [Build for production](#build-for-production) + - [Configuration](#configuration) + - [Usage](#usage) + - [Web UI](#web-ui) + - [Direct API](#direct-api) + - [API Reference](#api-reference) + - [Scan Flow](#scan-flow) + - [Project Structure](#project-structure) + - [Tech Stack](#tech-stack) + - [Testing](#testing) + - [Deployment](#deployment) + - [Roadmap](#roadmap) + - [Contributing](#contributing) + - [Good first issues](#good-first-issues) + - [FAQ](#faq) + - [Community \& Support](#community--support) + - [Security](#security) + - [License](#license) + - [What AGPL-3.0 means in practice](#what-agpl-30-means-in-practice) + - [Commercial Use](#commercial-use) + - [Hosted Version](#hosted-version) + - [Contributors](#contributors) + - [Acknowledgements](#acknowledgements) + - [Maintainer](#maintainer) --- diff --git a/docs/screenshot1.png b/docs/screenshot1.png new file mode 100644 index 0000000..bcee210 Binary files /dev/null and b/docs/screenshot1.png differ diff --git a/docs/screenshot2.png b/docs/screenshot2.png new file mode 100644 index 0000000..897d6ff Binary files /dev/null and b/docs/screenshot2.png differ diff --git a/docs/screenshot3.png b/docs/screenshot3.png new file mode 100644 index 0000000..f9dcb9b Binary files /dev/null and b/docs/screenshot3.png differ diff --git a/package.json b/package.json index 76ce089..a9b8fd9 100644 --- a/package.json +++ b/package.json @@ -20,5 +20,8 @@ }, "devDependencies": { "concurrently": "^9.1.0" - } + }, + "engines": { + "node": ">=22" +} }