Skip to content

Clean up README language #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Theauxm merged 1 commit into from
Apr 2, 2026
Merged

Clean up README language #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
[![NuGet Version](https://img.shields.io/nuget/v/Trax.Cli)](https://www.nuget.org/packages/Trax.Cli/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

CLI tool for [Trax](https://www.nuget.org/packages/Trax.Effect/) — generate Trax API projects from GraphQL or OpenAPI schemas.
CLI tool for [Trax](https://www.nuget.org/packages/Trax.Effect/). Generates Trax API projects from GraphQL or OpenAPI schemas.

## What This Does

Takes an existing API schema and scaffolds a Trax project with two parts: a hub project (from the `trax-hub` template — 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 — it can be referenced by an API, scheduler, or standalone workers.
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.

Supports two schema formats:

Expand Down Expand Up @@ -89,7 +89,7 @@ MyProject/
│ └── GetPlayerJunction.cs
```

Operations are grouped into folders by noun — `createPlayer`, `getPlayer`, `deletePlayer` all go under `Players/`.
Operations are grouped into folders by noun, so `createPlayer`, `getPlayer`, `deletePlayer` all go under `Players/`.

Each junction contains a `throw new NotImplementedException()` with a TODO comment. For OpenAPI sources, the original HTTP method and path are included as a comment.

Expand All @@ -108,7 +108,7 @@ dotnet run

## Part of Trax

Trax is a layered framework — each package builds on the one below it. Stop at whatever layer solves your problem.
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
Expand Down
Loading