Readme for nuget package built in

nicoco007 · Mar 18, 2022 · 00007a5 · 00007a5
1 parent 2bae39a
commit 00007a5
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 2 deletions.
diff --git a/BeatSaberPlaylistsLib.BeatSaber/BeatSaberPlaylistsLib.BeatSaber.csproj b/BeatSaberPlaylistsLib.BeatSaber/BeatSaberPlaylistsLib.BeatSaber.csproj
@@ -36,6 +36,7 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <Authors>Zingabopp</Authors>
     <Company>Zingabopp</Company>
+	<PackageReadmeFile>package_readme.md</PackageReadmeFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
     <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
@@ -55,6 +56,7 @@
       <Pack>True</Pack>
       <PackagePath></PackagePath>
     </None>
+	<None Include="package_readme.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/BeatSaberPlaylistsLib.BeatSaber/BeatSaberPlaylistsLib.xml b/BeatSaberPlaylistsLib.BeatSaber/BeatSaberPlaylistsLib.xml
diff --git a/BeatSaberPlaylistsLib.BeatSaber/package_readme.md b/BeatSaberPlaylistsLib.BeatSaber/package_readme.md
@@ -0,0 +1 @@
+A library to interact with Beat Saber playlists. Use the [BeatSaberPlaylistsLib](https://www.nuget.org/packages/BeatSaberPlaylistsLib/) package if this library is not being used inside a mod.
diff --git a/BeatSaberPlaylistsLib/BeatSaberPlaylistsLib.csproj b/BeatSaberPlaylistsLib/BeatSaberPlaylistsLib.csproj
@@ -31,6 +31,7 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
+	<PackageReadmeFile>package_readme.md</PackageReadmeFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
     <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
@@ -45,6 +46,7 @@
   </ItemGroup>
 
   <ItemGroup>
+	<None Include="package_readme.md" Pack="true" PackagePath="\" />
     <PackageReference Include="BeatSaberModdingTools.Tasks" Version="1.4.1">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

diff --git a/BeatSaberPlaylistsLib/package_readme.md b/BeatSaberPlaylistsLib/package_readme.md
@@ -0,0 +1 @@
+A library to interact with Beat Saber playlists. Use the [BeatSaberPlaylistsLib.BeatSaber](https://www.nuget.org/packages/BeatSaberPlaylistsLib.BeatSaber/) package if this library is being used inside a mod.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -3,7 +3,7 @@
 <Project>
   <PropertyGroup>
     <Authors>Zingabopp</Authors>
-    <Version>1.6.2</Version>    
+    <Version>1.6.3</Version>    
     <Copyright>Copyright © Zingabopp 2021</Copyright>
     <PackageProjectUrl>https://github.com/Zingabopp/BeatSaberPlaylistsLib</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Zingabopp/BeatSaberPlaylistsLib</RepositoryUrl>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		A library to interact with Beat Saber playlists. Use the [BeatSaberPlaylistsLib](https://www.nuget.org/packages/BeatSaberPlaylistsLib/) package if this library is not being used inside a mod.