Skip to content

Commit

Permalink
docs: readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkCoderSc committed Jan 21, 2022
1 parent 768fad0 commit d78345a
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Tested on:
* Windows 10 - PowerShell Version: 5.1.19041.1320
* Windows 11 - PowerShell Version: 5.1.22000.282

Current version: **1.0.6 Stable**

## Features

https://user-images.githubusercontent.com/2520298/150001915-0982fb1c-a729-4b21-b22c-a58e201bfe27.mp4
Expand All @@ -31,11 +33,29 @@ https://user-images.githubusercontent.com/2520298/150001915-0982fb1c-a729-4b21-b
* Multi-Screen (Monitor) support. If remote computer have more than one desktop screen, you can choose which desktop screen to capture.
* View Only mode for demonstration. You can disable remote control abilities and just show your screen to remote peer.

## What is still beta
## Development Roadmap

### Version 1.x (Now marked as stable)

Version `1.x` development is now over, only bug fix and improvements will be pushed to dedicated branch.

### Version 2.x (In progress)

Version `2.x` development is in progress with one new big feature and one huge improvement.

#### Feature

Version 1.0.5 Beta 6 is the last beta before final version.
Motion detection for desktop capture. Instead of capturing the whole screen, only updated screen areas will be sent to viewer thus improving considerably the streaming speed and reducing CPU usage.

No more features will be added in 1.x version, just optimization and bug fix.
#### Improvement

A huge part of the protocol will be updated.

The whole handshake progress will be cleaner and both Server and Viewer will respectively acknowledge their desired configuration.

For example, instead of setting the image quality in server option (which makes no sense), it will be available from viewer option and sent to server.

Same thing for image resizing, instead of resizing desktop image viewer-side, image will be resized server-side accordingly with viewer constraints.

## Installation

Expand Down Expand Up @@ -305,6 +325,11 @@ Detail Fingerprint
* Clipboard synchronization Viewer <-> Server added.
* Server support a new option to only show desktop (Mouse moves, clicks, wheel and keyboard control is disabled in this mode).

### 21 January 2022 (1.0.6)

* TransportMode option removed.
* Desktop streaming performance / speed increased.

### List of ideas and TODO

* 🟢 Support Password Protected external Certificates.
Expand Down

0 comments on commit d78345a

Please sign in to comment.