Skip to content

Commit

Permalink
doc: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
netpyoung committed Dec 7, 2024
1 parent 91fc2d9 commit 460d3a0
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# NF.Tool.ReleaseNoteMaker

[![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker)
[![.NET Test Workflow](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/actions/workflows/dotnet-test.yml/badge.svg)](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/actions/workflows/dotnet-test.yml)
[![Document](https://img.shields.io/badge/document-docfx-blue)](https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/)
[![License](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/netpyoung/NF.Tool.ReleaseNoteMaker/blob/main/LICENSE.md)

[![NuGet](https://img.shields.io/badge/NuGet-004880?logo=nuget&logoColor=fff)](https://www.nuget.org/packages/dotnet-release-note/)

wip

based on python [TownCrier](https://github.com/twisted/towncrier)

- [doc](https://netpyoung.github.io/NF.Tool.ReleaseNoteMaker/)

## Install

``` bash
dotnet tool install --global dotnet-release-note
```

## used

- use [Toml format](https://toml.io/en/) and [xoofx/Tomlyn library](https://github.com/xoofx/Tomlyn) for Config file.
Expand Down

0 comments on commit 460d3a0

Please sign in to comment.