Skip to content

Rewrite README with train metaphor#9

Merged
Theauxm merged 1 commit intomainfrom
docs/update-readme
Mar 2, 2026
Merged

Rewrite README with train metaphor#9
Theauxm merged 1 commit intomainfrom
docs/update-readme

Conversation

@Theauxm
Copy link
Copy Markdown
Member

@Theauxm Theauxm commented Mar 2, 2026

Summary

  • Expand README to cover ServiceTrain vs Train (locomotive vs full commercial service)
  • Document all effect providers with their packages and what they do
  • Add setup examples for production (Postgres) and development (InMemory)
  • Cover journey lifecycle states, DI registration helpers, and station service composition
  • Add NuGet and license badges, ecosystem package table, and link to docs site

Test plan

  • Verify README renders correctly on GitHub
  • Verify NuGet badge resolves
  • Verify docs site link works

Expand the README to cover ServiceTrain vs Train, effect providers,
journey lifecycle, installation options, setup examples, and DI
registration helpers.
@Theauxm Theauxm merged commit 0ea1c64 into main Mar 2, 2026
1 check passed
@traxsharp
Copy link
Copy Markdown

traxsharp Bot commented Mar 2, 2026

This PR is included in version 1.2.0

@Theauxm Theauxm deleted the docs/update-readme branch March 6, 2026 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant