Merge pull request #71 from andy840119/add-nuget-readme

Add nuget readme.
karaoke-dev · Jul 28, 2024 · 85cc166 · 85cc166
2 parents f87a2ac + 1888654
commit 85cc166
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,4 @@
+## 2024.0728
+* Add `StartTime` property in the `Model.Lyric` class. This property is used to store the start time of the lyric.~~
+* `LrcParse` is re-written. Now it can follow the [LRC and Enhanced LRC format](https://en.wikipedia.org/wiki/LRC_(file_format) to decode/encode the lyric correctly.
+* Create the `KarParser`, which is~~~~ u~~~~sed to parse the Karaoke file with format like `[00:51.00]ka[01:29.99]ra[01:48.29]o[02:31.00]ke[02:41.99]`.
diff --git a/LrcParser/LrcParser.csproj b/LrcParser/LrcParser.csproj
@@ -25,11 +25,13 @@
         <PackageReleaseNotes>喵</PackageReleaseNotes>
         <PackageId>LrcParser</PackageId>
         <NeutralLanguage>en</NeutralLanguage>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
         <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
             <_Parameter1>$(AssemblyName).Tests</_Parameter1>
         </AssemblyAttribute>
+        <None Include="..\README.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
 </Project>
diff --git a/README.md b/README.md
@@ -10,3 +10,5 @@
 [![Dashboard](https://img.shields.io/badge/Dashboard-stonks!-informational)](https://www.repotrends.com/karaoke-dev/LrcParser)
 
 A package to encode and decode the .lrc format.
+
+See the [Changelog](https://github.com/karaoke-dev/LrcParser/blob/main/CHANGELOG.md) to check the breaking change.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,3 +10,5 @@
		[![Dashboard](https://img.shields.io/badge/Dashboard-stonks!-informational)](https://www.repotrends.com/karaoke-dev/LrcParser)

		A package to encode and decode the .lrc format.

		See the [Changelog](https://github.com/karaoke-dev/LrcParser/blob/main/CHANGELOG.md) to check the breaking change.