Skip to content

Commit 7ea3b4a

Browse files
committed
update readme
1 parent 5d08ed9 commit 7ea3b4a

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ NetArchTest.eNhancedEdition is based on [NetArchTest v1.3.2](https://github.com/
66

77
## Rationale
88

9-
9+
NetArchTest is well established mature library, but in order to push things forward, a few breaking changes had to be made, and that is how **eNhancedEdition** has born. eNhancedEdition uses almost identical Fluent API as a base library, but it is not 100% backward compatible, and it will never be. The main goal is to offer more, and not to be a replacement.
1010

1111
## Getting started
1212

@@ -38,9 +38,9 @@ var result = Types.InCurrentDomain()
3838

3939
## Writing rules
4040

41-
The fluent API should direct you in building up a rule based on a combination of predicates, conditions and conjunctions.
41+
The fluent API should direct you in building up a rule, based on a combination of predicates, conditions and conjunctions.
4242

43-
The starting point for any rule is the static `Types` class, where you load a set of types from a path, assembly or namespace.
43+
The starting point for any rule is the static `Types` class, where you load a set of types from a path, assembly.
4444

4545
```csharp
4646
var types = Types.InAssembly(typeof(MyClass).Assembly);
@@ -55,7 +55,9 @@ types.That().ResideInNamespace(“MyProject.Data”).Should().BeSealed();
5555
```
5656
Finally, you obtain a result from the rule by using an executor, i.e. use `GetTypes()` to return the types that match the rule or `GetResult()` to determine whether the rule has been met. Note that the result will also return a list of types that failed to meet the conditions.
5757
```csharp
58-
var isValid = types.That().ResideInNamespace(“MyProject.Data”).Should().BeSealed().GetResult().IsSuccessful;
58+
var result = types.That().ResideInNamespace(“MyProject.Data”).Should().BeSealed().GetResult();
59+
var isValid = result.IsSuccessful;
60+
var types = result.FailingTypes;
5961
```
6062

6163

0 commit comments

Comments
 (0)