Skip to content

Commit

Permalink
Update README.md (#507)
Browse files Browse the repository at this point in the history
* Update README.md

* Add files via upload

* Update README.md
  • Loading branch information
guibranco authored Aug 20, 2024
1 parent 2b4ef42 commit 516cb0f
Show file tree
Hide file tree
Showing 2 changed files with 153 additions and 138 deletions.
291 changes: 153 additions & 138 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ Documentation: [Read the Docs](https://guibranco.github.io/CrispyWaffle/)

- [CI/CD](#cicd): Current project status in the build pipeline (AppVeyor).
- [Code Quality](#code-quality): Metrics from some tools about code quality.
- [.NET support](#.NET-support): Supported .NET version.
- [Installation](#installation): How to install/download this tool.
- [User guide](#user-guide): How to set up, configure and use this tool.
- [Change log](#changelog): Changelog containing the changes that were done in this project.
- [Change log](#changelog): Changelog containing the changes done in this project.
- [Support](#support): How to get support.
- [Contributing](#contributing): How to contribute.

Expand Down Expand Up @@ -58,6 +59,20 @@ Documentation: [Read the Docs](https://guibranco.github.io/CrispyWaffle/)

---

## .NET support

As of August 2024, this toolkit is currently published in the following `.NET` versions:

- .NET Standard 2.0
- .NET Standard 2.1
- .NET 6.0
- .NET 8.0

This is an official Microsoft [.NET-supported versions](https://dotnet.microsoft.com/en-us/platform/dotnet-standard) table based on the lowest target version (.NET Standard 2.0):
![Supported version as of Aug/2024](docs/images/supported-versions-2024-08.png)

---

## Installation

### Github Releases
Expand Down Expand Up @@ -114,146 +129,146 @@ Refer to [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to this p

### Contributors

<!-- readme: collaborators,contributors,snyk-bot/-,guistracini-outsurance-ie/-,codefactor-io/- -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/guibranco">
<img src="https://avatars.githubusercontent.com/u/3362854?v=4" width="100;" alt="guibranco"/>
<br />
<sub><b>Guilherme Branco Stracini</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Mohammad-Haris">
<img src="https://avatars.githubusercontent.com/u/34305911?v=4" width="100;" alt="Mohammad-Haris"/>
<br />
<sub><b>Mohammad Haris</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Looseling">
<img src="https://avatars.githubusercontent.com/u/69507148?v=4" width="100;" alt="Looseling"/>
<br />
<sub><b>Batyrkhan Akzholov</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/joaovaladares">
<img src="https://avatars.githubusercontent.com/u/42593399?v=4" width="100;" alt="joaovaladares"/>
<br />
<sub><b>João Vítor Valadares</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/SimranGil">
<img src="https://avatars.githubusercontent.com/u/111714647?v=4" width="100;" alt="SimranGil"/>
<br />
<sub><b>Simran Gill</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/thiagochfc">
<img src="https://avatars.githubusercontent.com/u/36862932?v=4" width="100;" alt="thiagochfc"/>
<br />
<sub><b>Thiago Christopher</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/tiagoschaffer">
<img src="https://avatars.githubusercontent.com/u/12534089?v=4" width="100;" alt="tiagoschaffer"/>
<br />
<sub><b>Tiago Schäffer</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/viktoriussuwandi">
<img src="https://avatars.githubusercontent.com/u/68414300?v=4" width="100;" alt="viktoriussuwandi"/>
<br />
<sub><b>Viktorius Suwandi</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Yousef-Majidi">
<img src="https://avatars.githubusercontent.com/u/28239685?v=4" width="100;" alt="Yousef-Majidi"/>
<br />
<sub><b>Yousef</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/akhtareimon">
<img src="https://avatars.githubusercontent.com/u/15952495?v=4" width="100;" alt="akhtareimon"/>
<br />
<sub><b>akhtareimon</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: collaborators,contributors,snyk-bot/-,guistracini-outsurance-ie/-,codefactor-io/- -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/guibranco">
<img src="https://avatars.githubusercontent.com/u/3362854?v=4" width="100;" alt="guibranco"/>
<br />
<sub><b>Guilherme Branco Stracini</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Mohammad-Haris">
<img src="https://avatars.githubusercontent.com/u/34305911?v=4" width="100;" alt="Mohammad-Haris"/>
<br />
<sub><b>Mohammad Haris</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Looseling">
<img src="https://avatars.githubusercontent.com/u/69507148?v=4" width="100;" alt="Looseling"/>
<br />
<sub><b>Batyrkhan Akzholov</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/joaovaladares">
<img src="https://avatars.githubusercontent.com/u/42593399?v=4" width="100;" alt="joaovaladares"/>
<br />
<sub><b>João Vítor Valadares</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/SimranGil">
<img src="https://avatars.githubusercontent.com/u/111714647?v=4" width="100;" alt="SimranGil"/>
<br />
<sub><b>Simran Gill</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/thiagochfc">
<img src="https://avatars.githubusercontent.com/u/36862932?v=4" width="100;" alt="thiagochfc"/>
<br />
<sub><b>Thiago Christopher</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/tiagoschaffer">
<img src="https://avatars.githubusercontent.com/u/12534089?v=4" width="100;" alt="tiagoschaffer"/>
<br />
<sub><b>Tiago Schäffer</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/viktoriussuwandi">
<img src="https://avatars.githubusercontent.com/u/68414300?v=4" width="100;" alt="viktoriussuwandi"/>
<br />
<sub><b>Viktorius Suwandi</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Yousef-Majidi">
<img src="https://avatars.githubusercontent.com/u/28239685?v=4" width="100;" alt="Yousef-Majidi"/>
<br />
<sub><b>Yousef</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/akhtareimon">
<img src="https://avatars.githubusercontent.com/u/15952495?v=4" width="100;" alt="akhtareimon"/>
<br />
<sub><b>akhtareimon</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: collaborators,contributors,snyk-bot/-,guistracini-outsurance-ie/-,codefactor-io/- -end -->

### Bots

<!-- readme: bots,snyk-bot -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/dependabot[bot]">
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="100;" alt="dependabot[bot]"/>
<br />
<sub><b>dependabot[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/github-actions[bot]">
<img src="https://avatars.githubusercontent.com/in/15368?v=4" width="100;" alt="github-actions[bot]"/>
<br />
<sub><b>github-actions[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/deepsource-autofix[bot]">
<img src="https://avatars.githubusercontent.com/in/57168?v=4" width="100;" alt="deepsource-autofix[bot]"/>
<br />
<sub><b>deepsource-autofix[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/stack-file[bot]">
<img src="https://avatars.githubusercontent.com/in/408123?v=4" width="100;" alt="stack-file[bot]"/>
<br />
<sub><b>stack-file[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/codefactor-io[bot]">
<img src="https://avatars.githubusercontent.com/in/25603?v=4" width="100;" alt="codefactor-io[bot]"/>
<br />
<sub><b>codefactor-io[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<br />
<sub><b>gitauto-ai[bot]</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/snyk-bot">
<img src="https://avatars.githubusercontent.com/u/19733683?v=4" width="100;" alt="snyk-bot"/>
<br />
<sub><b>Snyk bot</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: bots,snyk-bot -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/dependabot[bot]">
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="100;" alt="dependabot[bot]"/>
<br />
<sub><b>dependabot[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/github-actions[bot]">
<img src="https://avatars.githubusercontent.com/in/15368?v=4" width="100;" alt="github-actions[bot]"/>
<br />
<sub><b>github-actions[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/deepsource-autofix[bot]">
<img src="https://avatars.githubusercontent.com/in/57168?v=4" width="100;" alt="deepsource-autofix[bot]"/>
<br />
<sub><b>deepsource-autofix[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/stack-file[bot]">
<img src="https://avatars.githubusercontent.com/in/408123?v=4" width="100;" alt="stack-file[bot]"/>
<br />
<sub><b>stack-file[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/codefactor-io[bot]">
<img src="https://avatars.githubusercontent.com/in/25603?v=4" width="100;" alt="codefactor-io[bot]"/>
<br />
<sub><b>codefactor-io[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<br />
<sub><b>gitauto-ai[bot]</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/snyk-bot">
<img src="https://avatars.githubusercontent.com/u/19733683?v=4" width="100;" alt="snyk-bot"/>
<br />
<sub><b>Snyk bot</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: bots,snyk-bot -end -->

Binary file added docs/images/supported-versions-2024-08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 516cb0f

Please sign in to comment.