Skip to content

Commit b2eb647

Browse files
committed
docs: update README structure and improve section headings for clarity
1 parent e949aa4 commit b2eb647

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,23 @@ limitations under the License. -->
2424
Enterprise-grade cross-platform SDK for YubiKey integration, built on .NET.
2525

2626
## Table of Contents
27-
- [Quick Start](#quick-start)
28-
- [Documentation](#documentation)
29-
- [SDK Support](#sdk-support)
30-
- [SDK Packages](#sdk-packages)
31-
- [Project Structure](#project-structure)
32-
- [Contributing](#contributing)
33-
- [Security](#security)
27+
- [.NET YubiKey SDK](#net-yubikey-sdk)
28+
- [Table of Contents](#table-of-contents)
29+
- [Quick Start](#quick-start)
30+
- [Installation](#installation)
31+
- [Basic Usage](#basic-usage)
32+
- [Documentation](#documentation)
33+
- [SDK Support](#sdk-support)
34+
- [SDK Packages](#sdk-packages)
35+
- [Public Assemblies](#public-assemblies)
36+
- [Yubico.YubiKey](#yubicoyubikey)
37+
- [Yubico.Core](#yubicocore)
38+
- [Internal Assemblies](#internal-assemblies)
39+
- [Yubico.NativeShims](#yubiconativeshims)
40+
- [Project Structure](#project-structure)
41+
- [Contributing](#contributing)
42+
- [Building the Project](#building-the-project)
43+
- [Connect with us](#connect-with-us)
3444

3545
## Quick Start
3646

@@ -44,7 +54,7 @@ dotnet add package Yubico.YubiKey
4454
using Yubico.YubiKey;
4555

4656
// Chooses the first YubiKey found on the computer.
47-
IYubiKeyDevice? SampleChooseYubiKey()
57+
IYubiKeyDevice? GetFirstYubiKey()
4858
{
4959
IEnumerable<IYubiKeyDevice> list = YubiKeyDevice.FindAll();
5060
return list.First();
@@ -83,10 +93,6 @@ Platform abstraction layer (PAL) providing:
8393

8494
### Internal Assemblies
8595

86-
#### Yubico.DotNetPolyfills
87-
> ⚠️ **Not for public use**
88-
> Backports BCL features needed by the SDK.
89-
9096
#### Yubico.NativeShims
9197
> ⚠️ **Not for public use**
9298
> 🔧 **Unmanaged Library**

0 commit comments

Comments
 (0)