Skip to content

Commit c11715c

Browse files
committed
docs: reorganized README.md
1 parent 40d4ba8 commit c11715c

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,51 @@ This is a cross-platform, all encompassing SDK for the YubiKey aimed at large to
2525
customers. This version is written against .NET Core, and will eventually include bindings to languages
2626
outside the direct .NET ecosystem.
2727

28-
## SDK Support
29-
The SDK is targetting net47, netstandard2.0 and netstandard2.1. This means the SDK can be loaded in NET Framework, NET6 and upwards.
28+
## Quick Start
29+
```csharp
30+
// Installation
31+
dotnet add package Yubico.YubiKey
32+
```
3033

3134
## Documentation
3235

3336
The public documentation for this project is located
34-
at [https://docs.yubico.com/yesdk/](https://docs.yubico.com/yesdk/).
37+
at [https://docs.yubico.com/yesdk/](https://docs.yubico.com/yesdk/).
3538
Here you can find both API reference and a user's manual that describes the concepts that this SDK exposes.
3639

40+
## SDK Support
41+
The SDK is targeting net47, netstandard2.0 and netstandard2.1.
42+
This means the SDK can be loaded in NET Framework, NET6 and upwards.
43+
44+
## SDK Packages
45+
46+
The SDK consists of the following assemblies:
47+
48+
### Public Assemblies
49+
50+
#### Yubico.YubiKey
51+
Primary assembly containing all classes and types needed for YubiKey interaction.
52+
53+
#### Yubico.Core
54+
Platform abstraction layer (PAL) providing:
55+
- OS-specific functionality abstraction
56+
- Device enumeration
57+
- Utility classes for various encoding/decoding operations:
58+
- Base32
59+
- Tag-Length-Value (BER TLV)
60+
- ModHex
61+
62+
### Internal Assemblies
63+
64+
#### Yubico.DotNetPolyfills
65+
> ⚠️ **Not for public use**
66+
> Backports BCL features needed by the SDK. Target newer .NET versions directly if you need modern features.
67+
68+
#### Yubico.NativeShims
69+
> ⚠️ **Not for public use**
70+
> 🔧 **Unmanaged Library**
71+
> Provides stable ABI for P/Invoke operations in Yubico.Core.
72+
3773
## Project structure
3874

3975
The root of this repository contains the various projects that make up the SDK. Inside each project

0 commit comments

Comments
 (0)