diff --git a/README_Template.md b/README_Template.md
index 42969edc46..ae912f54ac 100644
--- a/README_Template.md
+++ b/README_Template.md
@@ -1,277 +1,423 @@
-
+
-A modern, flexible and fast testing framework for C#. With Native AOT and Trimmed Single File application support included!
+# ๐ The Modern Testing Framework for .NET
-TUnit is designed to aid with all testing types:
+**TUnit** is a next-generation testing framework for C# that outpaces traditional frameworks with **source-generated tests**, **parallel execution by default**, and **Native AOT support**. Built on the modern Microsoft.Testing.Platform, TUnit delivers faster test runs, better developer experience, and unmatched flexibility.
-- Unit
-- Integration
-- Acceptance
-- and more!
+
[](https://trendshift.io/repositories/11781)
-[](https://app.codacy.com/gh/thomhurst/TUnit?utm_source=github.com&utm_medium=referral&utm_content=thomhurst/TUnit&utm_campaign=Badge_Grade)  
+
+[](https://app.codacy.com/gh/thomhurst/TUnit?utm_source=github.com&utm_medium=referral&utm_content=thomhurst/TUnit&utm_campaign=Badge_Grade) 
[](https://github.com/sponsors/thomhurst) [](https://www.nuget.org/packages/TUnit/) [](https://www.nuget.org/packages/TUnit/)   
-# Quick Start
+
+
+## โก Why Choose TUnit?
+
+| Feature | Traditional Frameworks | **TUnit** |
+|---------|----------------------|-----------|
+| Test Discovery | โ Runtime reflection | โ
**Compile-time generation** |
+| Execution Speed | โ Sequential by default | โ
**Parallel by default** |
+| Modern .NET | โ ๏ธ Limited AOT support | โ
**Full Native AOT & trimming** |
+| Test Dependencies | โ Not supported | โ
**`[DependsOn]` chains** |
+| Resource Management | โ Manual lifecycle | โ
**Intelligent cleanup** |
-Assuming you have the .NET SDK installed, simply run:
+โก **Parallel by Default** - Tests run concurrently with intelligent dependency management
-`dotnet new install TUnit.Templates`
+๐ฏ **Compile-Time Discovery** - Know your test structure before runtime
-`dotnet new TUnit -n "YourProjectName"`
+๐ง **Modern .NET Ready** - Native AOT, trimming, and latest .NET features
-A new test project will be created for you with some samples of different test types and tips. When you're ready to get going, delete them and create your own!
+๐ญ **Extensible** - Customize data sources, attributes, and test behavior
-# Documentation
+---
-See here:
+
-# Modern and Fast
+## ๐ **[Complete Documentation & Learning Center](https://tunit.dev)**
-TUnit leverages source generators to locate and register your tests as opposed to reflection. You'll have a slight bump in build time, but a speedier runtime.
+**๐ New to TUnit?** Start with our **[Getting Started Guide](https://tunit.dev/docs/getting-started/installation)**
-TUnit also builds upon the newer Microsoft.Testing.Platform, whereas most other frameworks you'll have used will use VSTest. The new platform was reconstructed from the ground up to address pain points, be more extensible, and be faster.
+**๐ Migrating?** See our **[Migration Guides](https://tunit.dev/docs/getting-started/migration-from-xunit)** from xUnit, NUnit, or MSTest
-# Hooks, Events and Lifecycles
+**๐ฏ Advanced Features?** Explore **[Data-Driven Testing](https://tunit.dev/docs/test-authoring/arguments)**, **[Test Dependencies](https://tunit.dev/docs/test-authoring/depends-on)**, and **[Parallelism Control](https://tunit.dev/docs/parallelism/not-in-parallel)**
-One of the most powerful parts of TUnit is the information you have available to you because of the source generation and the events you can subscribe to. Because tests are constructed at the point of discovery, and not at runtime, you know all your arguments, properties, etc. upfront.
+
-You can then register to be notified about various events such as test registered (scheduled to run in this test session at some point in the future), test started, test finished, etc.
+---
-Say we injected an external object into our tests: By knowing how many tests are registered, we could count them up, and then on a test end event, we could decrease the count. When hitting 0, we know our object isn't going to be used by any other tests, so we can dispose of it. We know when we can handle the lifecycle, and this prevents it from living till the end of the test session where it could be hanging on to precious resources.
+## ๐ Quick Start
-# Flexible Data Inputs
+### Using the Project Template (Recommended)
+```bash
+dotnet new install TUnit.Templates
+dotnet new TUnit -n "MyTestProject"
+```
+
+### Manual Installation
+```bash
+dotnet add package TUnit --prerelease
+```
-One popular feature of TUnit is the `[ClassDataSource]` attribute - Allowing you to inject in classes to your tests with specific lifetimes, such as Per Test Session, or Per Test Class.
-Or if you want to run a combination of lots of different inputs, you can use a `[MatrixDataSource]` and annotate your parameters with `[Matrix(...)`] values.
+๐ **[๐ Complete Documentation & Guides](https://tunit.dev)** - Everything you need to master TUnit
-But guess what? Those features are built on top of a `DataSourceGenerator` class - Which is exposed directly to you.
-That means that that functionality can be extended greatly. If they didn't exist already, you could implement them yourself!
+## โจ Key Features
-So if you've got creative or complex ways to generate new data, this gives you the flexibility to do it.
-You create a class which will end up being an attribute you place on your test - So your test classes remain simple and readable!
+
+
+|
-# Built in Analyzers
+**๐ Performance & Modern Platform**
+- ๐ฅ Source-generated tests (no reflection)
+- โก Parallel execution by default
+- ๐ Native AOT & trimming support
+- ๐ Optimized for performance
-TUnit tries to help you write your tests correctly with analyzers. If something isn't quite right, an analyzer should tell you what's wrong.
+ |
+
-# IDE
+**๐ฏ Advanced Test Control**
+- ๐ Test dependencies with `[DependsOn]`
+- ๐๏ธ Parallel limits & custom scheduling
+- ๐ก๏ธ Built-in analyzers & compile-time checks
+- ๐ญ Custom attributes & extensible conditions
-TUnit is built on top of the newer Microsoft.Testing.Platform, as opposed to the older VSTest platform. Because the infrastructure behind the scenes is new and different, you may need to enable some settings. This should just be a one time thing.
+ |
+
+
+|
-## Visual Studio
+**๐ Rich Data & Assertions**
+- ๐ Multiple data sources (`[Arguments]`, `[Matrix]`, `[ClassData]`)
+- โ
Fluent async assertions
+- ๐ Smart retry logic & conditional execution
+- ๐ Rich test metadata & context
-Visual Studio is fully supported from 2022 17.13 onwards. The "Use testing platform server mode" option is not present from 2022 17.13 onwards.
+ |
+
-For prior versions, the "Use testing platform server mode" option must be selected in Tools > Manage Preview Features.
+**๐ง Developer Experience**
+- ๐ Full dependency injection support
+- ๐ช Comprehensive lifecycle hooks
+- ๐ฏ IDE integration (VS, Rider, VS Code)
+- ๐ Extensive documentation & examples
+
+ |
+
+
+
+## ๐ Simple Test Example
+
+```csharp
+[Test]
+public async Task User_Creation_Should_Set_Timestamp()
+{
+ // Arrange
+ var userService = new UserService();
+
+ // Act
+ var user = await userService.CreateUserAsync("john.doe@example.com");
+
+ // Assert - TUnit's fluent assertions
+ await Assert.That(user.CreatedAt)
+ .IsEqualTo(DateTime.Now)
+ .Within(TimeSpan.FromMinutes(1));
+
+ await Assert.That(user.Email)
+ .IsEqualTo("john.doe@example.com");
+}
+```
-
+## ๐ฏ Data-Driven Testing
-## Rider
+```csharp
+[Test]
+[Arguments("user1@test.com", "ValidPassword123")]
+[Arguments("user2@test.com", "AnotherPassword456")]
+[Arguments("admin@test.com", "AdminPass789")]
+public async Task User_Login_Should_Succeed(string email, string password)
+{
+ var result = await authService.LoginAsync(email, password);
+ await Assert.That(result.IsSuccess).IsTrue();
+}
+
+// Matrix testing - tests all combinations
+[Test]
+[MatrixDataSource]
+public async Task Database_Operations_Work(
+ [Matrix("Create", "Update", "Delete")] string operation,
+ [Matrix("User", "Product", "Order")] string entity)
+{
+ await Assert.That(await ExecuteOperation(operation, entity))
+ .IsTrue();
+}
+```
+
+## ๐ Advanced Test Orchestration
+
+```csharp
+[Before(Class)]
+public static async Task SetupDatabase(ClassHookContext context)
+{
+ await DatabaseHelper.InitializeAsync();
+}
+
+[Test, DisplayName("Register a new account")]
+[MethodDataSource(nameof(GetTestUsers))]
+public async Task Register_User(string username, string password)
+{
+ // Test implementation
+}
+
+[Test, DependsOn(nameof(Register_User))]
+[Retry(3)] // Retry on failure
+public async Task Login_With_Registered_User(string username, string password)
+{
+ // This test runs after Register_User completes
+}
+
+[Test]
+[ParallelLimit] // Custom parallel control
+[Repeat(100)] // Run 100 times
+public async Task Load_Test_Homepage()
+{
+ // Performance testing
+}
+
+// Custom attributes
+[Test, WindowsOnly, RetryOnHttpError(5)]
+public async Task Windows_Specific_Feature()
+{
+ // Platform-specific test with custom retry logic
+}
+
+public class LoadTestParallelLimit : IParallelLimit
+{
+ public int Limit => 10; // Limit to 10 concurrent executions
+}
+```
+
+## ๐ง Smart Test Control
+
+```csharp
+// Custom conditional execution
+public class WindowsOnlyAttribute : SkipAttribute
+{
+ public WindowsOnlyAttribute() : base("Windows only test") { }
+
+ public override Task ShouldSkip(TestContext testContext)
+ => Task.FromResult(!OperatingSystem.IsWindows());
+}
+
+// Custom retry logic
+public class RetryOnHttpErrorAttribute : RetryAttribute
+{
+ public RetryOnHttpErrorAttribute(int times) : base(times) { }
+
+ public override Task ShouldRetry(TestInformation testInformation,
+ Exception exception, int currentRetryCount)
+ => Task.FromResult(exception is HttpRequestException { StatusCode: HttpStatusCode.ServiceUnavailable });
+}
+```
-Rider is supported. The [Enable Testing Platform support](https://www.jetbrains.com/help/rider/Reference__Options__Tools__Unit_Testing__VSTest.html) option must be selected in Settings > Build, Execution, Deployment > Unit Testing > VSTest.
+## ๐ฏ Perfect For Every Testing Scenario
-
+
+
+|
-# VS Code
+### ๐งช **Unit Testing**
+```csharp
+[Test]
+[Arguments(1, 2, 3)]
+[Arguments(5, 10, 15)]
+public async Task Calculate_Sum(int a, int b, int expected)
+{
+ await Assert.That(Calculator.Add(a, b))
+ .IsEqualTo(expected);
+}
+```
+**Fast, isolated, and reliable**
-Visual Studio Code is supported.
+ |
+
-- Install the extension Name: [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
-- Go to the C# Dev Kit extension's settings
-- Enable Dotnet > Test Window > Use Testing Platform Protocol
+### ๐ **Integration Testing**
+```csharp
+[Test, DependsOn(nameof(CreateUser))]
+public async Task Login_After_Registration()
+{
+ // Runs after CreateUser completes
+ var result = await authService.Login(user);
+ await Assert.That(result.IsSuccess).IsTrue();
+}
+```
+**Stateful workflows made simple**
-
+ |
+
-## CLI
+### โก **Load Testing**
+```csharp
+[Test]
+[ParallelLimit]
+[Repeat(1000)]
+public async Task API_Handles_Concurrent_Requests()
+{
+ await Assert.That(await httpClient.GetAsync("/api/health"))
+ .HasStatusCode(HttpStatusCode.OK);
+}
+```
+**Built-in performance testing**
-`dotnet` CLI - Fully supported. Tests should be runnable with `dotnet test`, `dotnet run`, `dotnet exec` or executing an executable directly. See the docs for more information!
+ |
+
+
-# Packages
+## ๐ What Makes TUnit Different?
-## TUnit.Core
+### **Compile-Time Intelligence**
+Tests are discovered at build time, not runtime - enabling faster discovery, better IDE integration, and precise resource lifecycle management.
-To be used when you want to define re-useable components, such as a test library, but it wouldn't be run as its own test suite.
+### **Parallel-First Architecture**
+Built for concurrency from day one with `[DependsOn]` for test chains, `[ParallelLimit]` for resource control, and intelligent scheduling.
-## TUnit.Engine
+### **Extensible by Design**
+The `DataSourceGenerator` pattern and custom attribute system let you extend TUnit's capabilities without modifying core framework code.
-For test suites. This contains the test execution logic and test adapter. Only install this on actual test projects you intend to run, not class libraries.
+## ๐ Community & Ecosystem
-## TUnit.Assertions
+
-This is independent from the framework and can be used wherever - Even in other test frameworks. It is just an assertion library used to assert data is as you expect. It uses an asychronous syntax which may be different to other assertion libraries you may have used.
+**๐ Join thousands of developers modernizing their testing**
-## TUnit
+[](https://www.nuget.org/packages/TUnit/)
+[](https://github.com/thomhurst/TUnit/graphs/contributors)
+[](https://github.com/thomhurst/TUnit/discussions)
-This is a helper package to combine the above 3 packages. If you just want a standard test app where you can write, run and assert tests, just install this!
+
-## TUnit.Playwright
+### ๐ค **Active Community**
+- ๐ **[Official Documentation](https://tunit.dev)** - Comprehensive guides, tutorials, and API reference
+- ๐ฌ **[GitHub Discussions](https://github.com/thomhurst/TUnit/discussions)** - Get help and share ideas
+- ๐ **[Issue Tracking](https://github.com/thomhurst/TUnit/issues)** - Report bugs and request features
+- ๐ข **[Release Notes](https://github.com/thomhurst/TUnit/releases)** - Stay updated with latest improvements
-This provides you base classes, similarly to Microsoft.Playwright.NUnit or Microsoft.Playwright.MSTest, to automatically create and dispose of Playwright objects in tests, to make it easier for you to write tests without worrying about lifecycles or disposing. The base classes are named the same as the other libraries: `PageTest`, `ContextTest`, `BrowserTest`, and `PlaywrightTest`.
+## ๐ ๏ธ IDE Support
-# Features
+TUnit works seamlessly across all major .NET development environments:
-- Native AOT / Trimmed Single File application support
-- Source generated tests
-- Property injection
-- Full async support
-- Parallel by default, with mechanisms to:
+### Visual Studio (2022 17.13+)
+โ
**Fully supported** - No additional configuration needed for latest versions
+โ๏ธ **Earlier versions**: Enable "Use testing platform server mode" in Tools > Manage Preview Features
- - Run specific tests completely on their own
- - Run specific tests not in parallel with other specific tests
- - Limit the parallel limit on a per-test, class or assembly level
+### JetBrains Rider
+โ
**Fully supported**
+โ๏ธ **Setup**: Enable "Testing Platform support" in Settings > Build, Execution, Deployment > Unit Testing > VSTest
-- Tests can depend on other tests to form chains, useful for if one test depends on state from another action. While not recommended for unit tests, this can be useful in integration testing where state matters
-- Easy to read assertions - though you're also free to use whichever assertion library you like
-- Injectable test data via classes, methods, compile-time args, or matrices
-- Hooks before and after:
+### Visual Studio Code
+โ
**Fully supported**
+โ๏ธ **Setup**: Install [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) and enable "Use Testing Platform Protocol"
- - TestDiscover
- - TestSession
- - Assembly
- - Class
- - Test
+### Command Line
+โ
**Full CLI support** - Works with `dotnet test`, `dotnet run`, and direct executable execution
-- Designed to avoid common pitfalls such as leaky test states
-- Dependency injection support ([See here](https://tunit.dev/docs/tutorial-advanced/dependency-injection))
-- Ability to view and interrogate metadata and results from various assembly/class/test context objects
+## ๐ฆ Package Options
-# Installation
+| Package | Use Case |
+|---------|----------|
+| **`TUnit`** | โญ **Start here** - Complete testing framework (includes Core + Engine + Assertions) |
+| **`TUnit.Core`** | ๐ Test libraries and shared components (no execution engine) |
+| **`TUnit.Engine`** | ๐ Test execution engine and adapter (for test projects) |
+| **`TUnit.Assertions`** | โ
Standalone assertions (works with any test framework) |
+| **`TUnit.Playwright`** | ๐ญ Playwright integration with automatic lifecycle management |
-`dotnet add package TUnit --prerelease`
+## ๐ฏ Migration from Other Frameworks
-# Example test
+**Coming from NUnit or xUnit?** TUnit maintains familiar syntax while adding modern capabilities:
```csharp
- [Test]
- public async Task Create_User_Has_Expected_Creation_Time()
- {
- var user = await CreateUser();
-
- await Assert.That(user.CreatedAt)
- .IsEqualTo(DateTime.Now)
- .Within(TimeSpan.FromMinutes(1));
- }
+// Enhanced with TUnit's advanced features
+[Test]
+[Arguments("value1")]
+[Arguments("value2")]
+[Retry(3)]
+[ParallelLimit]
+public async Task Modern_TUnit_Test(string value) { }
```
-or with more complex test orchestration needs
+๐ **Need help migrating?** Check our detailed **[Migration Guides](https://tunit.dev/docs/getting-started/migration-from-xunit)** with step-by-step instructions for xUnit, NUnit, and MSTest.
-```csharp
- [Before(Class)]
- public static async Task ClearDatabase(ClassHookContext context) { ... }
-
- [After(Class)]
- public static async Task AssertDatabaseIsAsExpected(ClassHookContext context) { ... }
-
- [Before(Test)]
- public async Task CreatePlaywrightBrowser(TestContext context) { ... }
-
- [After(Test)]
- public async Task DisposePlaywrightBrowser(TestContext context) { ... }
-
- [Retry(3)]
- [Test, DisplayName("Register an account")]
- [MethodDataSource(nameof(GetAuthDetails))]
- public async Task Register(string username, string password) { ... }
-
- [Repeat(5)]
- [Test, DependsOn(nameof(Register))]
- [MethodDataSource(nameof(GetAuthDetails))]
- public async Task Login(string username, string password) { ... }
-
- [Test, DependsOn(nameof(Login), [typeof(string), typeof(string)])]
- [MethodDataSource(nameof(GetAuthDetails))]
- public async Task DeleteAccount(string username, string password) { ... }
-
- [Category("Downloads")]
- [Timeout(300_000)]
- [Test, NotInParallel(Order = 1)]
- public async Task DownloadFile1() { ... }
-
- [Category("Downloads")]
- [Timeout(300_000)]
- [Test, NotInParallel(Order = 2)]
- public async Task DownloadFile2() { ... }
-
- [Repeat(10)]
- [Test]
- [Arguments(1)]
- [Arguments(2)]
- [Arguments(3)]
- [DisplayName("Go to the page numbered $page")]
- public async Task GoToPage(int page) { ... }
-
- [Category("Cookies")]
- [Test, Skip("Not yet built!")]
- public async Task CheckCookies() { ... }
-
- [Test, Explicit, WindowsOnlyTest, RetryHttpServiceUnavailable(5)]
- [Property("Some Key", "Some Value")]
- public async Task Ping() { ... }
-
- [Test]
- [ParallelLimit]
- [Repeat(1000)]
- public async Task LoadHomepage() { ... }
-
- public static IEnumerable<(string Username, string Password)> GetAuthDetails()
- {
- yield return ("user1", "password1");
- yield return ("user2", "password2");
- yield return ("user3", "password3");
- }
-
- public class WindowsOnlyTestAttribute : SkipAttribute
- {
- public WindowsOnlyTestAttribute() : base("Windows only test")
- {
- }
-
- public override Task ShouldSkip(TestContext testContext)
- {
- return Task.FromResult(!OperatingSystem.IsWindows());
- }
- }
-
- public class RetryHttpServiceUnavailableAttribute : RetryAttribute
- {
- public RetryHttpServiceUnavailableAttribute(int times) : base(times)
- {
- }
-
- public override Task ShouldRetry(TestInformation testInformation, Exception exception, int currentRetryCount)
- {
- return Task.FromResult(exception is HttpRequestException { StatusCode: HttpStatusCode.ServiceUnavailable });
- }
- }
-
- public class LoadTestParallelLimit : IParallelLimit
- {
- public int Limit => 50;
- }
+
+## ๐ก Current Status
+
+The API is mostly stable, but may have some changes based on feedback or issues before v1.0 release.
+
+---
+
+
+
+## ๐ Ready to Experience the Future of .NET Testing?
+
+### โก **Start in 30 Seconds**
+
+```bash
+# Create a new test project with examples
+dotnet new install TUnit.Templates && dotnet new TUnit -n "MyAwesomeTests"
+
+# Or add to existing project
+dotnet add package TUnit --prerelease
```
-# Motivations
+### ๐ฏ **Why Wait? Join the Movement**
+
+
+
+|
+
+### ๐ **Performance**
+**Optimized execution**
+**Parallel by default**
+**Zero reflection overhead**
+
+ |
+
+
+### ๐ฎ **Future-Ready**
+**Native AOT support**
+**Latest .NET features**
+**Source generation**
+
+ |
+
+
+### ๐ ๏ธ **Developer Experience**
+**Compile-time checks**
+**Rich IDE integration**
+**Intelligent debugging**
-TUnit is inspired by NUnit and xUnit - two of the most popular testing frameworks for .NET.
+ |
+
-It aims to build upon the useful features of both while trying to address any pain points that they may have.
+### ๐ญ **Flexibility**
+**Test dependencies**
+**Custom attributes**
+**Extensible architecture**
-[Read more here](https://tunit.dev/docs/comparison/framework-differences)
+ |
+
+
-# Prerelease
+---
-You'll notice that version 1.0 isn't out yet. While this framework is mostly feature complete, I'm waiting for a few things:
+**๐ Learn More**: [tunit.dev](https://tunit.dev) | **๐ฌ Get Help**: [GitHub Discussions](https://github.com/thomhurst/TUnit/discussions) | **โญ Show Support**: [Star on GitHub](https://github.com/thomhurst/TUnit)
-- Full Rider support for all features
-- Full VS support for all features
-- Open to feedback on existing features
-- Open to ideas on new features
+*TUnit is actively developed and production-ready. Join our growing community of developers who've made the switch!*
-As such, the API may change. I'll try to limit this but it's a possibility.
+