Including README.md in the NuGet Packages

[DennisDyallo]

Description

Now including README.md in the NuGet packages, which creates a better first impression of the project.

Why include the README?

Key changes in the README

Here are the key changes made to improve the README.md:

Table of Contents

• Fixed anchor links by using GitHub-compatible formatting
• Added nested structure for better navigation
• Added missing sections

Content Organization

• Added Basic Usage section with practical code example
• Streamlined the introduction
• Removed redundant content

Formatting

• Added emoji icons for better visual hierarchy
• Consistent heading levels
• Clean spacing and indentation

Structure

• Added clear sections for Installation and Basic Usage
• Simplified the Security section
• Added direct issue creation link

Removed

• Redundant documentation explanations
• Extra whitespace
• Unnecessary technical details

The main focus was on making the document more navigable and user-friendly while maintaining all essential information.

[github-actions]

Test Results: Windows

    2 files      2 suites   5s ⏱️
3 741 tests 3 741 ✅ 0 💤 0 ❌
3 743 runs  3 743 ✅ 0 💤 0 ❌

Results for commit 1e55362.

[github-actions]

Test Results: Ubuntu

    2 files      2 suites   10s ⏱️
3 733 tests 3 733 ✅ 0 💤 0 ❌
3 735 runs  3 735 ✅ 0 💤 0 ❌

Results for commit 1e55362.

[github-actions]

Test Results: MacOS

    2 files      2 suites   4s ⏱️
3 733 tests 3 733 ✅ 0 💤 0 ❌
3 735 runs  3 735 ✅ 0 💤 0 ❌

Results for commit 1e55362.

[github-actions]

Package	Line Rate	Branch Rate	Complexity	Health
Yubico.Core	44%	32%	4311	➖
Yubico.YubiKey	49%	46%	19671	➖
Summary	48% (32918 / 68499)	43% (8245 / 18990)	23982	➖

Minimum allowed line rate is 40%

[DennisDyallo]

fyi @dainnilsson