Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lemonmojo authored Nov 6, 2024
1 parent dd13140 commit c799959
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[![Build RoyalVNCDemo](https://github.com/royalapplications/royalvnc-demo/actions/workflows/build-royalvncdemo.yml/badge.svg)](https://github.com/royalapplications/royalvnc-demo/actions/workflows/build-royalvncdemo.yml) [![Build RoyalVNCObjCDemo](https://github.com/royalapplications/royalvnc-demo/actions/workflows/build-royalvncobjcdemo.yml/badge.svg)](https://github.com/royalapplications/royalvnc-demo/actions/workflows/build-royalvncobjcdemo.yml) [![Build RoyalVNCiOSDemo](https://github.com/royalapplications/royalvnc-demo/actions/workflows/build-royalvnciosdemo.yml/badge.svg)](https://github.com/royalapplications/royalvnc-demo/actions/workflows/build-royalvnciosdemo.yml)
[![CI](https://github.com/royalapplications/royalvnc/actions/workflows/ci.yml/badge.svg)](https://github.com/royalapplications/royalvnc/actions/workflows/ci.yml)

![RoyalVNC](Design/Banner_Rendered/Banner.png)

RoyalVNC is a modern, high performance implementation of the [VNC/RFB protocol](https://github.com/rfbproto/rfbproto/blob/master/rfbproto.rst) written in Swift.
The SDK (RoyalVNCKit) is compatible with Swift, Objective-C, and C on macOS, iOS, iPadOS, Linux and Windows.
The SDK (RoyalVNCKit) is compatible with Swift, Objective-C, C and C# on macOS, iOS, iPadOS, Linux and Windows.
It has no external dependencies but includes some free (public domain) third party code from the libtommath, libtomcrypt and D3DES libraries (see [Credits](#Credits)).

## Supported Features
Expand Down Expand Up @@ -37,7 +37,8 @@ It has no external dependencies but includes some free (public domain) third par
- Connection state management and rendering is decoupled from each other, so it's possible to build "headless" clients (ie. no rendering of the remote desktop).
- The SDK includes a ready-to-use implementation of a framebuffer view for macOS (subclass of `NSView`), which also handles mouse and keyboard input, local cursor (`NSCursor`), scaling and rendering. The iOS/iPadOS equivalent (`UIView`) is a work-in-progress.
- First-class error handling. The `VNCError` type divides all possible errors into three broad categories: Protocol, Authentication and Connection errors. There are helper functions to retrieve human-readable descriptions for all errors and a convenience functions that allows the SDK consumer to distinguish between errors that should be displayed to the user and ones that shouldn't.
- Headless CLI demos (one using Swift and another one using the C API) are included in the repository.
- Headless CLI demos (one using Swift and another one using the C API) are included in the repository.
- The repository also contains C# bindings so the library can be used with .NET.
- [This repository](https://github.com/royalapplications/royalvnc-demo) contains Demo/Sample clients for macOS (one written in Swift, one in Objective-C) and iOS/iPadOS.

## Usage
Expand Down

0 comments on commit c799959

Please sign in to comment.