Skip to content

🚧Add README to NuGet package #39

@CalvinWilkinson

Description

@CalvinWilkinson

I have done the items below . . .

  • I have updated the title without removing the 🚧 emoji.

Description

Add a README.md to the NuGet package.
This can be done by making some changes to the .csproj file.

Resources:

Refer to the issue in the dependencies section below for more info.

Here are the things to add:

<PackageReadmeFile>README.md</PackageReadmeFile>
  <ItemGroup>
    <None Include="..\README.md">
      <Pack>True</Pack>
      <PackagePath>\</PackagePath>
    </None>
  </ItemGroup>

Project File:

    <PackageIconUrl />
    <PackageId>KinsonDigital.CASL</PackageId>
    <PackageIcon>casl-logo.png</PackageIcon>
+  <PackageReadmeFile>README.md</PackageReadmeFile>
    <None Include="..\LICENSE.md">
      <Pack>True</Pack>
      <PackagePath></PackagePath>
    </None>
+   <None Include="..\README.md" Pack="true" PackagePath="\"/>

Acceptance Criteria

This issue is finished when:

  • README added to package.

ToDo Items

  • Change type labels added to this issue. Refer to the Change Type Labels section below.
  • Priority label added to this issue. Refer to the Priority Type Labels section below.
  • Issue linked to the correct project (if applicable).
  • Issue linked to the correct milestone (if applicable).
  • Draft pull request created and linked to this issue (only required with code changes).

Issue Dependencies

Related Work

No response

Additional Information:

Change Type Labels

Change Type Label
Bug Fixes 🐛bug
Breaking Changes 🧨breaking changes
New Feature ✨new feature
Workflow Changes workflow
Code Doc Changes 🗒️documentation/code
Product Doc Changes 📝documentation/product

Priority Type Labels

Priority Type Label
Low Priority low priority
Medium Priority medium priority
High Priority high priority

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions