Update the release notes for 1.0.0

team-charls · Jan 23, 2021 · 3c53d52 · 3c53d52
1 parent 592220b
commit 3c53d52
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 14 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -13,6 +13,9 @@ insert_final_newline = true
 [*.props]
 indent_size = 2
 
+[*.md]
+trim_trailing_whitespace = false
+
 [*.csproj]
 indent_size = 2
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,8 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Next-Release]
+## [1.0.0 - 2021-1-24]
 
 ### Added
 
-- Initial release
+- Initial release. Includes native CharLS library version 2.2.0.
diff --git a/README.md b/README.md
@@ -5,15 +5,16 @@
 
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://raw.githubusercontent.com/team-charls/charls-dotnet/master/LICENSE.md)
 [![Build Status](https://dev.azure.com/team-charls/charls-native-dotnet/_apis/build/status/team-charls.charls-native-dotnet?branchName=master)](https://dev.azure.com/team-charls/charls-native-dotnet/_build/latest?definitionId=4&branchName=master)
-[![NuGet Beta](https://img.shields.io/nuget/vpre/CharLS.Native.svg)](https://www.nuget.org/packages/CharLS.Native)
+[![NuGet](https://img.shields.io/nuget/v/CharLS.Native.svg)](https://www.nuget.org/packages/CharLS.Native)
 
 CharLS.Native .NET is an adapter assembly that provides access to the native CharLS JPEG-LS C++ implementation for .NET based applications.
 JPEG-LS (ISO-14495-1) is a lossless/near-lossless compression standard for continuous-tone images.
 
 ## Features
 
 * .NET 5.0 class library.
-* Supports the Windows platform in the x86 and x64 architecture.
+* Supports the Windows platform in the x86 and x64 architecture.  
+  Note: the Microsoft Visual C++ Redistributable for Visual Studio 2019 needs to be installed on the target system.
 
 ## Installation
 

diff --git a/src/CharLS.Native.csproj b/src/CharLS.Native.csproj
@@ -6,10 +6,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <Version>1.0.0-beta.1</Version>
+    <Version>1.0.0</Version>
     <AssemblyVersion>1.0.0.0</AssemblyVersion>
     <FileVersion>1.0.0.0</FileVersion>
-    <Copyright>Copyright 2020 Team CharLS</Copyright>
+    <Copyright>Copyright 2021 Team CharLS</Copyright>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 
@@ -20,10 +20,11 @@
     <!-- Configure NuGet package settings  -->
     <Company>Team CharLS</Company>
     <Authors>Team CharLS</Authors>
-    <Description>CharLS.Native is a .NET adapter assembly that provides access to the native CharLS JPEG-LS C++ implementation for .NET based applications.</Description>
+    <Description>CharLS.Native is a .NET adapter assembly that provides access to the native CharLS JPEG-LS C++ implementation for .NET based applications. JPEG-LS (ISO-14495-1) is a lossless/near-lossless compression standard for continuous-tone images.</Description>
     <PackageTags>jpeg-ls;compression;codec</PackageTags>
     <PackageIcon>icon.png</PackageIcon>
     <PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
+    <PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/nuget-release-notes.txt"))</PackageReleaseNotes>
     <RepositoryUrl>https://github.com/team-charls/charls-native-dotnet.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
 
@@ -35,8 +36,10 @@
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
 
-    <CertificateThumbprint Condition="'$(CertificateThumbprint)' == ''">6e78b103da0729369e44004121fb6bf685fec5d8</CertificateThumbprint>
-    <TimestampUrl Condition="'$(TimestampUrl)' == ''">http://time.certum.pl/</TimestampUrl>
+    <_CertificateThumbprint>$(CertificateThumbprint)</_CertificateThumbprint>
+    <_CertificateThumbprint Condition="'$(_CertificateThumbprint)' == ''">6e78b103da0729369e44004121fb6bf685fec5d8</_CertificateThumbprint>
+    <_TimestampUrl>$(TimestampUrl)</_TimestampUrl>
+    <_TimestampUrl Condition="'$(_TimestampUrl)' == ''">http://time.certum.pl/</_TimestampUrl>
   </PropertyGroup>
 
   <ItemGroup>
@@ -78,18 +81,18 @@
   <Target Name="SignDlls" BeforeTargets="GenerateNuspec">
     <!-- Use TargetFrameworkVersion=v4.5 to sign with SHA256 -->
     <Message Text="Signing CharLS.Native.dll" />
-    <SignFile CertificateThumbprint="$(CertificateThumbprint)" TimestampUrl="$(TimestampUrl)" SigningTarget="$(OutDir)\CharLS.Native.dll" TargetFrameworkVersion="v4.5" />
+    <SignFile CertificateThumbprint="$(_CertificateThumbprint)" TimestampUrl="$(_TimestampUrl)" SigningTarget="$(OutDir)\CharLS.Native.dll" TargetFrameworkVersion="v4.5" />
 
     <Message Text="Signing charls-2-x64.dll" />
-    <SignFile CertificateThumbprint="$(CertificateThumbprint)" TimestampUrl="$(TimestampUrl)" SigningTarget="$(OutDir)\charls-2-x64.dll" TargetFrameworkVersion="v4.5" />
+    <SignFile CertificateThumbprint="$(_CertificateThumbprint)" TimestampUrl="$(_TimestampUrl)" SigningTarget="$(OutDir)\charls-2-x64.dll" TargetFrameworkVersion="v4.5" />
 
     <Message Text="Signing charls-2-x86.dll" />
-    <SignFile CertificateThumbprint="$(CertificateThumbprint)" TimestampUrl="$(TimestampUrl)" SigningTarget="$(OutDir)\charls-2-x86.dll" TargetFrameworkVersion="v4.5" />
+    <SignFile CertificateThumbprint="$(_CertificateThumbprint)" TimestampUrl="$(_TimestampUrl)" SigningTarget="$(OutDir)\charls-2-x86.dll" TargetFrameworkVersion="v4.5" />
   </Target>
 
   <Target Name="SignPackage" AfterTargets="Pack">
-    <Exec Command="nuget sign $(OutDir)$(PackageId).$(Version).nupkg -Timestamper $(TimestampUrl) -CertificateFingerprint $(CertificateThumbprint)" />
-    <Exec Command="nuget sign $(OutDir)$(PackageId).$(Version).snupkg -Timestamper $(TimestampUrl) -CertificateFingerprint $(CertificateThumbprint)" />
+    <Exec Command="nuget sign $(OutDir)$(PackageId).$(Version).nupkg -Timestamper $(_TimestampUrl) -CertificateFingerprint $(_CertificateThumbprint)" />
+    <Exec Command="nuget sign $(OutDir)$(PackageId).$(Version).snupkg -Timestamper $(_TimestampUrl) -CertificateFingerprint $(_CertificateThumbprint)" />
   </Target>
 
 </Project>
diff --git a/src/nuget-release-notes.txt b/src/nuget-release-notes.txt
@@ -0,0 +1,2 @@
+1.0.0.
+ - Initial release. Includes native CharLS library version 2.2.0.