mirrors/PairDrop
1
0
Fork 0
mirror of https://github.com/schlagmichdoch/PairDrop.git synced 2025-04-27 18:26:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

add documentation for new features

Browse source
This commit is contained in:
schlagmichdoch 2023-01-19 19:07:43 +01:00
parent 469d3f6ec8
commit d6d5663ac4
7 changed files with 86 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -13,24 +13,38 @@ Developed based on [Snapdrop](https://github.com/RobinLinus/snapdrop)
* You will always discover devices on your local network. Paired devices are shown additionally.
* Paired devices outside your local network that are behind a NAT are connected automatically via [Open Relay: Free WebRTC TURN Server](https://www.metered.ca/tools/openrelay/)
[//]: # (Todo: add File Handler API Doku)
### [Improved UI for sending/receiving files](https://github.com/RobinLinus/snapdrop/issues/560)
* The receiving peer must accept the request of files **before** they are transferred and downloaded automatically afterwords if possible
* Multiple files are downloaded as ZIP file
* On iOS and Android the devices share menu is opened instead of downloading the files
* Multiple files are transferred at one archive which shows the overall progress correctly
* The integrity of the files is checked on receive
* By zipping the files before sending, all metadata is preserved
### Share Files Directly From Share / Context Menu
* [Share files directly form context menu on Windows](/docs/how-to.md#share-files-directly-form-context-menu-on-windows)
* [Share directly from share menu on iOS](/docs/how-to.md#share-directly-from-share-menu-on-ios)
* [Share directly from share menu on Android](/docs/how-to.md#share-directly-from-share-menu-on-android)
### Other changes
* [Paste Mode](https://github.com/RobinLinus/snapdrop/pull/534)
* [Video and Audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (thanks [@victorwads](https://github.com/victorwads))
* [Prevent device from sleeping on file transfer](https://github.com/RobinLinus/snapdrop/pull/413)
* node-only implementation (thanks [@Bellisario](https://github.com/Bellisario))
* automatic restart on error (thanks [@KaKi87](https://github.com/KaKi87))
* lots of stability fixes (thanks [@MWY001](https://github.com/MWY001) [@skiby7](https://github.com/skiby7) [@willstott101](https://github.com/willstott101))
* [Paste Mode](https://github.com/RobinLinus/snapdrop/pull/534)
* [Video and Audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (thanks [@victorwads](https://github.com/victorwads))
* To host PairDrop on your local network (e.g. on Raspberry Pi): [All peers connected with private IPs are discoverable by each other](https://github.com/RobinLinus/snapdrop/pull/558)
## Screenshot
![test](/docs/pairdrop_screenshot_desktop.png)
## Screenshots
![Pairdrop Preview](/docs/pairdrop_screenshot_mobile.gif)
## Snapdrop and PairDrop are built with the following awesome technologies:
## PairDrop is built with the following awesome technologies:
* Vanilla HTML5 / ES6 / CSS3 frontend
* [WebRTC](http://webrtc.org/) / [WebSockets](http://www.websocket.org/)
* [NodeJS](https://nodejs.org/en/) backend
* [Progressive Web App](https://wikipedia.org/wiki/Progressive_Web_App)
* [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
Have any questions? Read our [FAQ](/docs/faq.md).
@ -39,18 +53,16 @@ You can [host your own instance with Docker](/docs/host-your-own.md).
## Support the Community
PairDrop is free and always will be!
PairDrop is free and always will be. Still, we have to pay for the domain.
Do you want to support me?<br>
To contribute and support me:<br>
<a href="https://www.buymeacoffee.com/pairdrop" target="_blank">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" >
</a>
To support the original Snapdrop and its creator go to [his GitHub page](https://github.com/RobinLinus/snapdrop).
Thanks a lot for supporting free and open software!
To support the original Snapdrop and its creator go to [his GitHub page](https://github.com/RobinLinus/snapdrop).
## How to contribute