diff --git a/Common.Test.props b/Common.Test.props
index 3dd7f43..81c96ec 100644
--- a/Common.Test.props
+++ b/Common.Test.props
@@ -6,8 +6,6 @@
true
true
- false
-
false
true
diff --git a/Common.props b/Common.props
index 7b011a9..40704ef 100644
--- a/Common.props
+++ b/Common.props
@@ -28,11 +28,12 @@
AutoFixture Contributors
- https://github.com/AutoFixture/AutoFixture
+ https://github.com/AutoFixture/AutoFixture.TUnit
true
MIT
- https://raw.githubusercontent.com/AutoFixture/AutoFixture/79c882c3f4af3cf52ad43e5c95851f25d217ac17/AutoFixtureLogo200x200.png
+ https://raw.githubusercontent.com/AutoFixture/AutoFixture.TUnit/master/AutoFixtureLogo200x200.png
icon.png
+ README.md
$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb
true
@@ -42,6 +43,7 @@
+
@@ -52,23 +54,6 @@
-
-
-
- $(DefineConstants);SYSTEM_GLOBALIZATION_CULTUREINFO_CULTURESETTERS
-
-
-
-
- <_IsFullFramework>true
- $(DefineConstants);SYSTEM_NET_MAIL;SYSTEM_RUNTIME_SERIALIZATION;SERIALIZABLE_MEMBERINFO;SYSTEM_THREADING_THREAD_CULTURESETTERS;SYSTEM_TYPE_FULL
-
-
-
-
- $(DefineConstants);SYSTEM_NET_MAIL
-
-
@@ -77,7 +62,6 @@
- $(DefineConstants);CODE_ANALYSIS
true
true
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..648ea90
--- /dev/null
+++ b/README.md
@@ -0,0 +1,155 @@
+# AutoFixture.TUnit
+
+[](https://raw.githubusercontent.com/AutoFixture/AutoFixture.TUnit/master/LICENCE.txt)
+[](https://www.nuget.org/packages/AutoFixture.TUnit)
+
+[AutoFixture.TUnit](https://github.com/AutoFixture/AutoFixture.TUnit) is a .NET library that integrates [AutoFixture](https://github.com/AutoFixture/AutoFixture) with [TUnit](https://github.com/tunitframework/tunit), allowing you to effortlessly generate test data for your unit tests.
+By leveraging the data generators feature of TUnit, this extension turns AutoFixture into a declarative framework for writing unit tests. In many ways it becomes a unit testing DSL (Domain Specific Language).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+AutoFixture packages are distributed via NuGet.
+To install the packages you can use the integrated package manager of your IDE, the .NET CLI, or reference the package directly in your project file.
+
+```cmd
+dotnet add package AutoFixture.TUnit
+```
+
+## Getting Started
+
+### Basic Usage
+
+`AutoFixture.TUnit` provides an `[AutoDataSource]` attribute that automatically populates test method parameters with generated data.
+
+For example, imagine you have a simple calculator class:
+
+```csharp
+public class Calculator
+{
+ public int Add(int a, int b) => a + b;
+}
+```
+
+You can write a test using AutoFixture to provide the input values:
+
+```csharp
+using TUnit.Assertions;
+using AutoFixture.TUnit;
+
+public class CalculatorTests
+{
+ [Test, AutoDataSource]
+ public async Task Add_SimpleValues_ReturnsCorrectResult(
+ Calculator calculator, int a, int b)
+ {
+ // Act
+ int result = calculator.Add(a, b);
+
+ // Assert
+ await Assert.That(result).IsEqualTo(a + b);
+ }
+}
+```
+
+### Inline Auto-Data
+
+You can also combine auto-generated data with inline arguments using the `[AutoArguments]` attribute.
+This allows you to specify some parameters while still letting AutoFixture generate the rest.
+
+```csharp
+using TUnit.Assertions;
+using AutoFixture.TUnit;
+
+public class CalculatorTests
+{
+ [Test]
+ [AutoArguments(5, 8)]
+ public async Task Add_SpecificValues_ReturnsCorrectResult(
+ int a, int b, Calculator calculator)
+ {
+ // Act
+ int result = calculator.Add(a, b);
+
+ // Assert
+ await Assert.That(result).IsEqualTo(13);
+ }
+}
+```
+
+### Freezing Dependencies
+
+AutoFixture's `[Frozen]` attribute can be used to ensure that the same instance of a dependency is injected into multiple parameters.
+
+For example, if you have a consumer class that depends on a shared dependency:
+
+```csharp
+public class Dependency { }
+
+public class Consumer
+{
+ public Dependency Dependency { get; }
+
+ public Consumer(Dependency dependency)
+ {
+ Dependency = dependency;
+ }
+}
+```
+
+You can freeze the Dependency so that all requests for it within the test will return the same instance:
+
+```csharp
+using TUnit.Assertions;
+using AutoFixture.TUnit;
+
+public class ConsumerTests
+{
+ [Test, AutoDataSource]
+ public async Task Consumer_UsesSameDependency(
+ [Frozen] Dependency dependency, Consumer consumer)
+ {
+ // Assert
+ await Assert.That(consumer.Dependency).IsSameReferenceAs(dependency);
+ }
+}
+```
+
+## Features
+
+### Data Source Attributes
+
+- **`[AutoDataSource]`** - Automatically generates test data for all parameters
+- **`[AutoArguments]`** - Combines inline values with auto-generated data
+- **`[AutoMemberDataSource]`** - Uses static members (properties, fields, methods) as data sources
+- **`[AutoClassDataSource]`** - Uses classes implementing `IEnumerable` as data sources
+- **`[CompositeDataSource]`** - Composes multiple data source attributes together
+
+### Parameter Customization Attributes
+
+- **`[Frozen]`** - Freezes a parameter value so the same instance is reused (supports various matching criteria)
+- **`[Greedy]`** - Uses the constructor with the most parameters
+- **`[Modest]`** - Uses the constructor with the fewest parameters
+- **`[NoAutoProperties]`** - Prevents auto-population of properties
+- **`[FavorArrays]`** - Prefers constructors that take array parameters
+- **`[FavorEnumerables]`** - Prefers constructors that take `IEnumerable` parameters
+- **`[FavorLists]`** - Prefers constructors that take `IList` parameters
+
+All customization attributes can be combined and support custom fixture factories for advanced scenarios.
+
+## Contributing
+
+Contributions are welcome!
+If you would like to contribute, please review our contributing guidelines and open an issue or pull request.
+
+## License
+
+AutoFixture is Open Source software and is released under the [MIT license](LICENCE.txt).
+The license allows the use of AutoFixture libraries in free and commercial applications and libraries without restrictions.