Skip to content

Commit 27fb487

Browse files
docs: clarify desktop client is an example for builders, Windows-focused
1 parent 692a85b commit 27fb487

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ csharp-sdk/
189189
│ └── Sentinel.SDK.Tests/ # 814+ tests across 33 test classes
190190
191191
├── desktop/
192-
│ └── HandshakeDVPN/ # Full WPF desktop client (5,980 lines)
192+
│ └── HandshakeDVPN/ # Example WPF desktop client — Windows (5,980 lines)
193193
│ ├── App.xaml Theme system — colors, fonts, styles
194194
│ ├── MainWindow.xaml UI layout — sidebar, orb, status bar
195195
│ ├── MainWindow.xaml.cs App logic — state machine, events, polling
@@ -208,7 +208,7 @@ csharp-sdk/
208208

209209
## Example: Full WPF Desktop Client
210210

211-
The [`desktop/HandshakeDVPN/`](desktop/HandshakeDVPN/) directory contains a complete, runnable dVPN desktop application built with WPF and .NET 8. Use it as a reference for building your own Windows desktop VPN client.
211+
The [`desktop/HandshakeDVPN/`](desktop/HandshakeDVPN/) directory contains a complete **example** Windows dVPN desktop application built with WPF and .NET 8. It is not a production release — it's a reference for builders creating their own Windows desktop VPN clients.
212212

213213
**What's included (5,980 lines across 7 files):**
214214

desktop/HandshakeDVPN/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# Handshake dVPN — WPF Desktop Client
1+
# Handshake dVPN — Example WPF Desktop Client
22

3-
A fully functional decentralized VPN desktop client built with **C# / WPF / .NET 8.0** on the [Sentinel Network](https://sentinel.co). Uses Handshake DNS by default for uncensorable domain resolution.
3+
> **This is an example application for builders, not a production release.** Use it as a starting point and reference for building your own Windows dVPN client with the Sentinel C# SDK.
44
5-
This repository serves as a **reference implementation** for developers building Windows desktop dVPN applications with the Sentinel C# SDK.
5+
A working example of a decentralized VPN desktop client built with **C# / WPF / .NET 8.0** on the [Sentinel Network](https://sentinel.co). Demonstrates how to integrate the Sentinel C# SDK into a real desktop application with a complete UI.
66

7-
![.NET 8.0](https://img.shields.io/badge/.NET-8.0-512BD4) ![WPF](https://img.shields.io/badge/WPF-Desktop-blue) ![Sentinel](https://img.shields.io/badge/Sentinel-dVPN-green) ![License](https://img.shields.io/badge/license-MIT-lightgrey)
7+
![Example](https://img.shields.io/badge/status-example-orange) ![.NET 8.0](https://img.shields.io/badge/.NET-8.0-512BD4) ![WPF](https://img.shields.io/badge/WPF-Desktop-blue) ![Sentinel](https://img.shields.io/badge/Sentinel-dVPN-green) ![License](https://img.shields.io/badge/license-MIT-lightgrey)
88

99
---
1010

1111
## What This Is
1212

13-
A production-quality example of how to build a dVPN desktop app using:
13+
A **Windows-focused example application** that shows builders how to build a dVPN desktop app using:
1414

1515
- **WPF (Windows Presentation Foundation)** for the UI layer
1616
- **Sentinel C# SDK** for blockchain interaction, node discovery, session management, and tunnel creation
1717
- **WireGuard + V2Ray** tunnel protocols
1818
- **Handshake DNS** (103.196.38.38) for decentralized name resolution through the tunnel
1919

20-
This is not a library — it's a complete, runnable application that demonstrates every pattern you need.
20+
This is not a production release or a library — it's a complete, runnable example that demonstrates every pattern you need to build your own client. Fork it, rip it apart, use whatever you need.
2121

2222
---
2323

0 commit comments

Comments
 (0)