From eb3c59da26612832860d01979894ce0209947281 Mon Sep 17 00:00:00 2001 From: Theaux Masquelier <43664045+Theauxm@users.noreply.github.com> Date: Tue, 5 May 2026 15:50:20 -0600 Subject: [PATCH] docs: add repo directory to top of README --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1223159..a7905c5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,23 @@ CLI tool for [Trax](https://www.nuget.org/packages/Trax.Effect/). Generates Trax API projects from GraphQL or OpenAPI schemas. +## The Trax Stack + +Trax is a layered framework split across several repos. You can stop at whatever layer solves your problem. **You are here: Trax.Cli.** + +| Repo | Adds | +|------|------| +| [Trax.Core](https://github.com/TraxSharp/Trax.Core) | Pipelines, junctions, railway error propagation | +| [Trax.Effect](https://github.com/TraxSharp/Trax.Effect) | Execution logging, DI, pluggable storage | +| [Trax.Mediator](https://github.com/TraxSharp/Trax.Mediator) | Decoupled dispatch via `TrainBus` | +| [Trax.Scheduler](https://github.com/TraxSharp/Trax.Scheduler) | Cron schedules, retries, dead-letter queues | +| [Trax.Api](https://github.com/TraxSharp/Trax.Api) | GraphQL API for remote access | +| [Trax.Dashboard](https://github.com/TraxSharp/Trax.Dashboard) | Blazor monitoring UI | +| **[Trax.Cli](https://github.com/TraxSharp/Trax.Cli)** | `trax-cli` project scaffolding tool | +| [Trax.Samples](https://github.com/TraxSharp/Trax.Samples) | Sample apps and a `dotnet new` template | + +Full documentation: [traxsharp.net/docs](https://traxsharp.net/docs). + ## What This Does Takes an existing API schema and scaffolds a Trax project with two parts: a hub project (from the `trax-hub` template, with API + Scheduler + Dashboard in one process) and a shared trains library with trains, junctions, input/output records, and models. The trains library follows the same structure as the DistributedWorkers sample and can be referenced by an API, scheduler, or standalone workers. @@ -107,22 +124,6 @@ dotnet run # Open http://localhost:5000/trax for Dashboard ``` -## Part of Trax - -Trax is a layered framework. Each package builds on the one below it, so stop at whatever layer solves your problem. - -``` -Trax.Core pipelines, junctions, railway error propagation -└→ Trax.Effect + execution logging, DI, pluggable storage - └→ Trax.Mediator + decoupled dispatch via TrainBus - └→ Trax.Scheduler + cron schedules, retries, dead-letter queues - └→ Trax.Api + GraphQL API layer - └→ Trax.Dashboard + Blazor monitoring UI -Trax.Cli ← you are here (standalone tool) -``` - -Full documentation: [traxsharp.net/docs](https://traxsharp.net/docs) - ## License MIT