v/deskreen
1
0
Fork 0
mirror of https://github.com/pavlobu/deskreen.git synced 2025-05-29 13:50:08 -07:00
Code Issues Projects Releases Wiki Activity

sharing session init docs added

Browse Source
This commit is contained in:
Pavlo Buidenkov 2021-01-22 12:18:50 +02:00
parent ea6ffb5d88
commit b7e089c763
3 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -16,8 +16,7 @@ It is built on top of [Electron React Boilerplate](https://github.com/electron-r
For better security mechanism, end-to-end encryption is implemented, which is inspired by For better security mechanism, end-to-end encryption is implemented, which is inspired by
[darkwire.io](https://github.com/darkwire/darkwire.io). The difference is that it is rewritten [darkwire.io](https://github.com/darkwire/darkwire.io). The difference is that it is rewritten
in `Typescript` and transformed to use `node-forge` instead of `window.crypto.subtle`. in `Typescript` and transformed to use `node-forge` instead of `window.crypto.subtle`.
Why this was made? Because a client served with `http` without SSL, which makes `window.crypto. subtle` unavailable. Why this was made? Because a client served with `http` without SSL, which makes `window.crypto.subtle` unavailable.
(TODO: write more docs about Deskreen architecture)
## Get Started for Developers ## Get Started for Developers
@ -77,10 +76,14 @@ TODO: add how to get started with local SonarCube for Deskreen in details.
## Documentation ## Documentation
### High level design ### High level architecture design
![high-level-design](./doc/architecture/deskreen-arch-pavlobu-21012021.svg) ![high-level-design](./doc/architecture/deskreen-arch-pavlobu-21012021.svg)
### WebRTC Screen Sharing Session Initiation Step by Step
![sharng-session-init](./doc/init-sharing-session/deskreen-webrtc-screen-sharing-session-initiation-pavlobu-22012021.svg)
## Note on versioning: ## Note on versioning:
- All versions git tags should start with `v` ex. `v1.0.0` - All versions git tags should start with `v` ex. `v1.0.0`

23
doc/init-sharing-session/deskreen-webrtc-screen-sharing-session-initiation-pavlobu-22012021.html Normal file
View File

File diff suppressed because one or more lines are too long

3
doc/init-sharing-session/deskreen-webrtc-screen-sharing-session-initiation-pavlobu-22012021.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 257 KiB