From 1207e52034d4eec285487026d2e162587880f33b Mon Sep 17 00:00:00 2001 From: Alexander Linne <alexander.linne@tngtech.com> Date: Fri, 24 May 2024 16:33:00 +0200 Subject: [PATCH] docs: update README.md badges Signed-off-by: Alexander Linne <alexander.linne@tngtech.com> --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bf98000c6..905fd3df7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ <img src="Logo/ArchUnitNET-Logo.png" height="64" alt="ArchUnit"> -# ArchUnitNET [](https://travis-ci.com/TNG/ArchUnitNET) [](https://github.com/TNG/ArchUnitNET/blob/master/LICENSE) [](https://www.nuget.org/packages/TngTech.ArchUnitNET/) +# ArchUnitNET [](https://github.com/TNG/ArchUnitNET/actions/workflows/build.yaml) [](https://github.com/TNG/ArchUnitNET/blob/master/LICENSE) [](https://www.nuget.org/packages/TngTech.ArchUnitNET/) [](https://codecov.io/gh/TNG/ArchUnitNET) Visit our documentation at https://archunitnet.readthedocs.io/en/latest/. @@ -9,18 +9,25 @@ classes, members, interfaces, and more. This is done by analyzing C# bytecode an structure. The main focus of ArchUnitNET is to automatically test architecture and coding rules. ## An Example + To use ArchUnitNET, install the ArchUnitNET package from NuGet: + ``` PS> Install-Package TngTech.ArchUnitNET ``` + If you want to use xUnit, NUnit or MSTestV2 for your unit tests, you should instead install the corresponding ArchUnit extension: + ``` PS> Install-Package TngTech.ArchUnitNET.xUnit PS> Install-Package TngTech.ArchUnitNET.NUnit PS> Install-Package TngTech.ArchUnitNET.MSTestV2 ``` + #### Create a Test + Then you will want to create a class to start testing. We used xUnit with the ArchUnit extension here, but it works similarly with NUnit or other Unit Test Frameworks. + ```cs using ArchUnitNET.Domain; @@ -106,12 +113,12 @@ namespace ExampleTest } ``` - #### Further Info and Help -Check out test examples for the current release at -[ArchUnitNET Examples](https://github.com/TNG/ArchUnitNET/tree/master/ExampleTest "ExampleTests"). +Check out test examples for the current release at +[ArchUnitNET Examples](https://github.com/TNG/ArchUnitNET/tree/master/ExampleTest "ExampleTests"). ## License + ArchUnitNET is published under the Apache License 2.0. For more information concerning the license, see [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).