diff --git a/README.md b/README.md index 27cac02..02621f3 100644 --- a/README.md +++ b/README.md @@ -3,133 +3,127 @@ Logo -

PairDrop

+ # _Send it_, with [PairDrop](https://pairdrop.net)

- Local file sharing in your browser. Inspired by Apple's AirDrop. -
- Explore » + Local file sharing in your web browser.

- Report Bug - · - Request Feature + Report a bug +
+ Request feature

## Features -[PairDrop](https://pairdrop.net) is a sublime alternative to AirDrop that works on all platforms. +File sharing on your local network that works on all platforms. -- File Sharing on your local network - - Send images, documents or text via peer to peer connection to devices on the same local network. -- Internet Transfers - - Join temporary public rooms to transfer files easily over the internet! -- Web-Application - - As it is web based, it runs on all devices. +- A multi-platform AirDrop-like solution that works. + - Send images, documents or text via peer-to-peer connection to devices on the same local network. +- Internet transfers + - Join temporary public rooms to transfer files easily over the Internet. +- Web-app + - Works on all devices with a modern web-browser. + +Send a file from your phone to your laptop? +
Share photos in original quality with friends using Android and iOS? +
Share private files peer-to-peer between Linux systems? -You want to quickly send a file from your phone to your laptop? -
You want to share photos in original quality with friends that use a mixture of Android and iOS? -
You want to share private files peer to peer between Linux systems? -
AirDrop is unreliable again? -
_Send it with PairDrop!_ +Screenshot GIF showing PairDrop in use -Developed based on [Snapdrop](https://github.com/RobinLinus/snapdrop) +## Differences to the [Snapdrop](https://github.com/RobinLinus/snapdrop) it is based on +
List view -## Differences to Snapdrop -
Click to expand - -### Paired Devices and Public Rooms - Internet Transfer -* Transfer files over the internet between paired devices or by entering temporary public rooms. -* Connect to devices in complex network environments (public Wi-Fi, company network, Apple Private Relay, VPN etc.). +### Paired Devices and Public Rooms — Internet Transfer +* Transfer files over the Internet between paired devices or by entering temporary public rooms. +* Connect to devices in complex network environments (public Wi-Fi, company network, iCloud Private Relay, VPN, etc.). * Connect to devices on your mobile hotspot. -* Devices outside your local network that are behind a NAT are connected automatically via the PairDrop TURN server. +* Devices outside of your local network that are behind a NAT are auto-connected via the PairDrop TURN server. * Connect to devices on your mobile hotspot. -* You will always discover devices on your local network. Paired devices and devices in the same public room are shown additionally. +* Devices from the local network, in the same public room, or previously paired are shown. #### Persistent Device Pairing -* Pair your devices via a 6-digit code or a QR-Code. -* Paired devices will always find each other via shared secrets independently of their local network. -* Paired devices are persistent. You find your devices even after reopening PairDrop. -* You can edit and unpair devices easily -* Ideal to always connect easily to your own devices + +Always connect to known devices + +* Pair devices via a 6-digit code or a QR-Code. +* Paired devices always find each other via shared secrets independently of their local network. +* Pairing is persistent. You find your devices even after reopening PairDrop. +* You can edit and unpair devices easily. #### Temporary Public Rooms -* Enter a public room via a 5-letter code or a QR-Code. -* Enter a public room to temporarily connect to devices outside your local network. -* All devices in the same public room see each other mutually. -* Public rooms are temporary. Public rooms are left as soon as PairDrop is closed. -* Ideal to connect easily to others in complex network situations or over the internet. -### [Improved UI for sending/receiving files](https://github.com/RobinLinus/snapdrop/issues/560) -* Files are transferred only after a request is accepted first. On transfer completion files are downloaded automatically if possible. +Connect to others in complex network situations, or over the Internet. + +* Enter a public room via a 5-letter code or a QR-code. +* Enter a public room to temporarily connect to devices outside your local network. +* All devices in the same public room see each other. +* Public rooms are temporary. Closing PairDrop leaves all rooms. + +### [Improved UI for Sending/Receiving Files](https://github.com/RobinLinus/snapdrop/issues/560) +* Files are transferred after a request is accepted. Files are auto-downloaded upon completing a transfer, if possible. * Multiple files are downloaded as a ZIP file -* On iOS and Android, in addition to downloading, files can be shared or saved to the gallery via the Share menu. -* Multiple files are transferred at once with an overall progress indicator +* Download, share or save to gallery via the "Share" menu on Android and iOS. +* Multiple files are transferred at once with an overall progress indicator. ### Send Files or Text Directly From Share Menu, Context Menu or CLI -* [Send files directly from context menu on Windows](docs/how-to.md#send-multiple-files-and-directories-directly-from-context-menu-on-windows) -* [Send files directly from context menu on Ubuntu (using Nautilus)](/docs/how-to.md#send-multiple-files-and-directories-directly-from-context-menu-on-ubuntu-using-nautilus) -* [Send files directly from share menu on iOS](docs/how-to.md#send-directly-from-share-menu-on-ios) -* [Send files directly from share menu on Android](docs/how-to.md#send-directly-from-share-menu-on-android) -* [Send files directly via command-line interface](docs/how-to.md#send-directly-via-command-line-interface) +* [Send files directly from context menu on Ubuntu (using Nautilus)](docs/how-to.md#send-multiple-files-and-directories-directly-from-context-menu-on-ubuntu-using-nautilus) +* [Send files directly from the context menu on Windows](docs/how-to.md#send-files-directly-from-context-menu-on-windows) +* [Send directly from the "Share" menu on iOS](docs/how-to.md#send-directly-from-share-menu-on-ios) +* [Send directly from the "Share" menu on Android](docs/how-to.md#send-directly-from-share-menu-on-android) +* [Send directly via the command-line interface](docs/how-to.md#send-directly-via-command-line-interface) -### Other changes -* Change your display name permanently to easily differentiate your devices -* [Paste files/text and choose the recipient afterwords ](https://github.com/RobinLinus/snapdrop/pull/534) +### Other Changes +* Change your display name to easily differentiate your devices. +* [Paste files/text and choose the recipient afterwards ](https://github.com/RobinLinus/snapdrop/pull/534) * [Prevent devices from sleeping on file transfer](https://github.com/RobinLinus/snapdrop/pull/413) * Warn user before PairDrop is closed on file transfer * Open PairDrop on multiple tabs simultaneously (Thanks [@willstott101](https://github.com/willstott101)) -* [Video and Audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (Thanks [@victorwads](https://github.com/victorwads)) -* Switch theme back to auto/system after darkmode or lightmode is enabled +* [Video and audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (Thanks [@victorwads](https://github.com/victorwads)) +* Switch theme back to auto/system after dark or light mode is on * Node-only implementation (Thanks [@Bellisario](https://github.com/Bellisario)) -* Automatic restart on error (Thanks [@KaKi87](https://github.com/KaKi87)) +* Auto-restart on error (Thanks [@KaKi87](https://github.com/KaKi87)) * Lots of stability fixes (Thanks [@MWY001](https://github.com/MWY001) [@skiby7](https://github.com/skiby7) and [@willstott101](https://github.com/willstott101)) * 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) -* When hosting PairDrop yourself you can [set your own STUN/TURN servers](docs/host-your-own.md#specify-stunturn-servers) -* Built-in translations via [Weblate](https://hosted.weblate.org/engage/pairdrop/) -* Airy design (Thanks [@Avieshek](https://linktr.ee/avieshek/)) +* When hosting PairDrop yourself, you can [set your own STUN/TURN servers](docs/host-your-own.md#specify-stunturn-servers) +* Translations.
-## Screenshots -Gif of Screenshots that show PairDrop in use - -## 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) -* [Weblate](https://weblate.org/) Web based localization tool -* [zip.js](https://github.com/gildas-lormeau/zip.js) JavaScript library to zip and unzip files ([BSD 3-Clause License](licenses/BSD_3-Clause-zip-js)) -* [NoSleep](https://github.com/richtr/NoSleep.js) JavaScript library to prevent display sleep and enable wake lock in any Android or iOS web browser ([MIT License](licenses/MIT-NoSleep)) -* [heic2any](https://github.com/alexcorvi/heic2any) JavaScript library to convert HEIC/HEIF images to PNG/GIF/JPEG ([MIT License](licenses/MIT-heic2any)) -* [cyrb53](https://github.com/bryc) Super fast hash function - -Have any questions? Read our [FAQ](docs/faq.md). - -You can [host your own instance with Docker](docs/host-your-own.md). - - -## Support PairDrop - -Buy Me A Coffee - - -PairDrop is free and always will be. -Still, we have to pay for the domain and the server. - -To contribute and support, please use BuyMeACoffee via the button above. - -Thanks a lot for supporting free and open software! - -## Translate PairDrop +## Translate PairDrop on [Hosted Weblate](https://hosted.weblate.org/engage/pairdrop/) -Translation status +Translation status -## How to contribute +## Built with the following awesome technologies: +* Vanilla HTML5 / JS ES6 / CSS 3 frontend +* [WebRTC](http://webrtc.org/) / WebSockets +* [Node.js](https://nodejs.org/en/) backend +* [Progressive web app (PWA)](https://en.wikipedia.org/wiki/Progressive_web_app) unified functionality +* [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) storage handling +* [zip.js](https://gildas-lormeau.github.io/zip.js/) library +* [cyrb53](https://github.com/bryc/code/blob/master/jshash/experimental/cyrb53.js) super-fast hash function +* [NoSleep](https://github.com/richtr/NoSleep.js) display sleep, add wake lock ([MIT](licenses/MIT-NoSleep)) +* [heic2any](https://github.com/alexcorvi/heic2any) HEIC/HEIF to PNG/GIF/JPEG ([MIT](licenses/MIT-heic2any)) +* [Weblate](https://weblate.org/) web-based localization tool +[FAQ](docs/faq.md) + +[Host your own instance with Docker or Node.js](docs/host-your-own.md). + +## Support + +Buy me a coffee + +
+
+ +PairDrop is libre, and always will be. \ +I footed the bill for the domain and the server, and you can help create great softeare by supporting me. \ +Please use BuyMeACoffee via the button above. \ +Thanks a lot for supporting copylefted libre software! + +## Contributing Feel free to [open an issue](https://github.com/schlagmichdoch/pairdrop/issues/new/choose) or a -[pull request](https://github.com/schlagmichdoch/pairdrop/pulls) but follow +[pull request](https://github.com/schlagmichdoch/pairdrop/pulls), following the [Contributing Guidelines](CONTRIBUTING.md).