Skip to content

Commit da48e28

Browse files
author
Per Kops
committed
docs: update readme
1 parent e7d31bc commit da48e28

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,39 @@ This repository contains a CLI tool, which can be used to maintain `coding-rules
77
* Read about [atc-coding-rules](https://github.com/atc-net/atc-coding-rules)
88
* Master rule files [information](https://github.com/atc-net/atc-coding-rules/tree/main/distribution)
99

10-
## Breaking changes
11-
12-
![](https://img.shields.io/static/v1?color=ff9900&style=for-the-badge&label=&message=Breaking%20changes%20From%20Version%201.x%20to%202.x)
13-
14-
```powershell
15-
* Options Parameter Change: -r | --rootPath has changed to -p | --projectPath
16-
* CLI Tool now requires the "run" command to update rule-files
17-
```
10+
## Table of Contents
11+
- [ATC-NET Coding rules updater](#atc-net-coding-rules-updater)
12+
- [Table of Contents](#table-of-contents)
13+
- [CLI Tool](#cli-tool)
14+
- [Requirements](#requirements)
15+
- [Installation](#installation)
16+
- [Update](#update)
17+
- [Usage](#usage)
18+
- [Option --help](#option---help)
19+
- [Command run](#command-run)
20+
- [Command sanity-check](#command-sanity-check)
21+
- [Command options-file](#command-options-file)
22+
- [Example](#example)
23+
- [Options file schema / example](#options-file-schema--example)
24+
- [atc-coding-rules-updater.json example 1](#atc-coding-rules-updaterjson-example-1)
25+
- [atc-coding-rules-updater.json example 2](#atc-coding-rules-updaterjson-example-2)
26+
- [atc-coding-rules-updater.json default](#atc-coding-rules-updaterjson-default)
27+
- [CLI Tool Usage from powershell](#cli-tool-usage-from-powershell)
28+
- [Deep dive in what `atc-coding-rules-updater` actual does and doesn't do](#deep-dive-in-what-atc-coding-rules-updater-actual-does-and-doesnt-do)
29+
- [A use case-scenario for coding rules structure setups - Scenario A](#a-use-case-scenario-for-coding-rules-structure-setups---scenario-a)
30+
- [A use case-scenario for coding rules structure setups - Scenario B](#a-use-case-scenario-for-coding-rules-structure-setups---scenario-b)
31+
- [For both use-case scenarios](#for-both-use-case-scenarios)
32+
- [Temporary suppressions](#temporary-suppressions)
33+
- [Build](#build)
34+
- [How to contribute](#how-to-contribute)
1835

1936
## CLI Tool
2037

2138
The Atc.CodingRules.Updater.CLI library is available through a cross platform command line application.
2239

2340
### Requirements
2441

25-
* [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
42+
* [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
2643

2744
### Installation
2845

0 commit comments

Comments
 (0)