Structure and requested fixes
This commit is contained in:
		
							parent
							
								
									4a5a2ceb67
								
							
						
					
					
						commit
						5dcda58ce5
					
				
							
								
								
									
										33
									
								
								README.md
								
								
								
								
							
							
						
						
									
										33
									
								
								README.md
								
								
								
								
							|  | @ -23,22 +23,24 @@ File sharing on your local network that works on all platforms. | ||||||
| - Internet transfers | - Internet transfers | ||||||
|   - Join temporary public rooms to transfer files easily over the Internet. |   - Join temporary public rooms to transfer files easily over the Internet. | ||||||
| - Web-app  | - Web-app  | ||||||
|   - Works on all devices with a web browser (that supports HTML5, CSS 3, JS, and WebRTC). |   - Works on all devices with a modern web-browser. | ||||||
|   |   | ||||||
| Send a file from your phone to your laptop? | Send a file from your phone to your laptop? | ||||||
| <br>Share photos in original quality with friends using Android and iOS? | <br>Share photos in original quality with friends using Android and iOS? | ||||||
| <br>Share private files peer-to-peer between Linux systems? | <br>Share private files peer-to-peer between Linux systems? | ||||||
| 
 | 
 | ||||||
|  | <img src="docs/pairdrop_screenshot_mobile.gif" style="max-height: 50vh"> | ||||||
|  | 
 | ||||||
| ## Differences to the [Snapdrop](https://github.com/RobinLinus/snapdrop) it is based on | ## Differences to the [Snapdrop](https://github.com/RobinLinus/snapdrop) it is based on | ||||||
| <details><summary>List view</summary> | <details><summary>List view</summary> | ||||||
| 
 | 
 | ||||||
| ### Paired Devices and Public Rooms — Internet Transfer | ### Paired Devices and Public Rooms — Internet Transfer | ||||||
| * Transfer files over the Internet between paired devices or by entering temporary public rooms. | * 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.). | * Connect to devices in complex network environments (public Wi-Fi, company network, iCloud Private Relay, VPN, etc.). | ||||||
| * Connect to devices on your mobile hotspot. | * Connect to devices on your mobile hotspot. | ||||||
| * Devices outside of your local network that are behind a NAT are autop-connected 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. | * Connect to devices on your mobile hotspot. | ||||||
| * Devices that are paired devices, in the same public room, or on your local network are shown. | * Devices from the local network, in the same public room, or previously paired are shown. | ||||||
| 
 | 
 | ||||||
| #### Persistent Device Pairing | #### Persistent Device Pairing | ||||||
| 
 | 
 | ||||||
|  | @ -87,38 +89,37 @@ Connect to others in complex network situations, or over the Internet. | ||||||
| 
 | 
 | ||||||
| </details> | </details> | ||||||
| 
 | 
 | ||||||
| ## Screenshots | ## Translate PairDrop on [Hosted Weblate](https://hosted.weblate.org/engage/pairdrop/) | ||||||
| <img src="docs/pairdrop_screenshot_mobile.gif" style="max-height: 50vh"> | <a href="https://hosted.weblate.org/engage/pairdrop/"> | ||||||
|  | <img src="https://hosted.weblate.org/widget/pairdrop/horizontal-blue.svg" alt="Translation status" /> | ||||||
|  | </a> | ||||||
| 
 | 
 | ||||||
| ## Built with the following awesome technologies: | ## Built with the following awesome technologies: | ||||||
| * Vanilla HTML5 / JS ES6 / CSS 3 frontend | * Vanilla HTML5 / JS ES6 / CSS 3 frontend | ||||||
| * [WebRTC](http://webrtc.org/) / WebSockets | * [WebRTC](http://webrtc.org/) / WebSockets | ||||||
| * [Node.js](https://nodejs.org/en/) backend | * [Node.js](https://nodejs.org/en/) backend | ||||||
| * [Progressive web app](https://wikipedia.org/wiki/Progressive_Web_App) | * [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) | * [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) storage handling | ||||||
| * [zip.js](https://gildas-lormeau.github.io/zip.js/) | * [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 | * [cyrb53](https://github.com/bryc/code/blob/master/jshash/experimental/cyrb53.js) super-fast hash function | ||||||
| * [Weblate](https://weblate.org/) web-based localization tool | * [Weblate](https://weblate.org/) web-based localization tool | ||||||
| 
 | 
 | ||||||
| [FAQ](docs/faq.md) | [FAQ](docs/faq.md) | ||||||
| 
 | 
 | ||||||
| [Host your own instance with Docker](docs/host-your-own.md). | [Host your own instance with Docker or Node.js](docs/host-your-own.md). | ||||||
| 
 | 
 | ||||||
| ## Support | ## Support | ||||||
| <a href="https://www.buymeacoffee.com/pairdrop" target="_blank"> | <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;" > | <img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy me a coffee" style="height: 60px !important;width: 217px !important;" > | ||||||
| </a> | </a> | ||||||
|  | <br /> | ||||||
|  | <br /> | ||||||
| 
 | 
 | ||||||
| PairDrop is libre, and always will be. \ | 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. \ | 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. \ | Please use BuyMeACoffee via the button above. \ | ||||||
| Thanks a lot for supporting copylefted libre software! | Thanks a lot for supporting copylefted libre software! | ||||||
| 
 | 
 | ||||||
| ## Translate PairDrop on Hosted Weblate |  | ||||||
| <a href="https://hosted.weblate.org/engage/pairdrop/"> |  | ||||||
| <img src="https://hosted.weblate.org/widget/pairdrop/pairdrop-spa/open-graph.png" alt="Translation status" style="max-height: 30vh" /> |  | ||||||
| </a> |  | ||||||
| 
 |  | ||||||
| ## Contributing | ## Contributing | ||||||
| Feel free to [open an issue](https://github.com/schlagmichdoch/pairdrop/issues/new/choose) or a | Feel free to [open an issue](https://github.com/schlagmichdoch/pairdrop/issues/new/choose) or a | ||||||
| [pull request](https://github.com/schlagmichdoch/pairdrop/pulls), following the | [pull request](https://github.com/schlagmichdoch/pairdrop/pulls), following the | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue
	
	 Allan Nordhøy
						Allan Nordhøy