| @@ -1,58 +1,53 @@ | ||
| 1 | -# Embed Privacy | |
| 1 | +=== Embed Privacy === | |
| 2 | +Contributors: epiphyt, kittmedia, krafit | |
| 3 | +Tags: oembed, privacy, gutenberg | |
| 4 | +Requires at least: 4.7 | |
| 5 | +Tested up to: 4.9 | |
| 6 | +Requires PHP: 5.6 | |
| 7 | +License: GPL2 | |
| 8 | +License URI: https://www.gnu.org/licenses/gpl-2.0.html | |
| 2 | 9 | |
| 3 | -Embed Privacy prevents the loading of embedded external content and allows your site visitors to opt-in. | |
| 10 | +Embed Privacy prevents loading of embeded external content and allows your site visitors to opt-in. | |
| 4 | 11 | |
| 5 | -Content embedded from external sites such as YouTube or Twitter is loaded immediately when visitors access your site. Embed Privacy addresses this issue and prevents the loading of these contents until the visitor decides to allow loading of external content. | |
| 6 | -But Embed Privacy not only protects your visitor's privacy but also makes your site load faster. | |
| 12 | +== Description == | |
| 7 | 13 | |
| 14 | +Content embedded from external sites such as YouTube or Twitter is loaded immediately when visitors access your site. Embed Privacy addresses this issue and prevents loading of these contents until the visitor decides to allow loading of external content. | |
| 15 | +But Embed Privacy not only protects your visitors privacy, but also makes your site load faster. | |
| 16 | + | |
| 8 | 17 | All embeds will be replaced by placeholders, ready for you to apply style as you wish. With only a couple of lines of CSS. |
| 9 | 18 | |
| 10 | -By clicking on the placeholder the respective content will then be loaded. | |
| 19 | +By clicking on the placeholder the respective content will be reloaded. | |
| 11 | 20 | |
| 12 | -## Requirements | |
| 13 | 21 | |
| 14 | -PHP: 5.6 including the `php-dom` extension<br> | |
| 15 | -WordPress: 5.9 | |
| 22 | +== Installation == | |
| 16 | 23 | |
| 17 | -## Building | |
| 24 | +1. Upload the plugin files to the `/wp-content/plugins/embed-privacy` directory, or install the plugin through the WordPress plugins screen directly. | |
| 25 | +1. Activate the plugin through the 'Plugins' screen in WordPress. | |
| 26 | +1. Embeded content will automatically be replaced by a placeholder and can be loaded on demand by your visitors. There are no additonal settings. | |
| 18 | 27 | |
| 19 | -First, you need to install all NPM dependencies. Make sure you have NPM installed first. Then, run this command: | |
| 20 | 28 | |
| 21 | -```bash | |
| 22 | -npm install | |
| 23 | -``` | |
| 29 | +== Frequently Asked Questions == | |
| 24 | 30 | |
| 25 | -### Development build | |
| 31 | += Can Embed Privacy keep external services from tracking me/my visitors? = | |
| 26 | 32 | |
| 27 | -To build assets for development purposes and to watch for changes, run this command: | |
| 33 | +Yes. As long as you don't opt-in to load external content, you/your visitors can't be tracked by these services. | |
| 28 | 34 | |
| 29 | -```bash | |
| 30 | -npm start | |
| 31 | -``` | |
| 35 | += Does Embed Privacy support the Gutenberg editor? = | |
| 32 | 36 | |
| 33 | -### Production build | |
| 37 | +Sure thing! We enjoy playing with the new WordPress editor and developed Embed Privacy with Gutenberg in mind, the plugin will work no matter the editor you use. | |
| 34 | 38 | |
| 35 | -To build assets for production, run this command: | |
| 39 | += Which embeds are currently supported? = | |
| 36 | 40 | |
| 37 | -```bash | |
| 38 | -npm run build | |
| 39 | -``` | |
| 41 | +We currently support all oEmbed providers known to WordPress core. Want to know about them? Here you go: Animoto, Cloudup, CollegeHumor, DailyMotion, Facebook, Flickr, Funny Or Die, Hulu, Imgur, Instagram, Issuu, Kickstarter, Meetup, Mixcloud, Photobucket, Photobucket, Polldaddy.com, Reddit, ReverbNation, Scribd, Sketchfab, SlideShare, SmugMug, SoundCloud, Speaker Deck, Spotify, TED, Tumblr, Twitter, VideoPres, Vimeo, WordPress.org, WordPress.tv, YouTube. | |
| 40 | 42 | |
| 41 | -## Contribution | |
| 43 | += Who are you folks? = | |
| 42 | 44 | |
| 43 | -Happy so see your interest in contributing! :heart: | |
| 45 | +We are [Epiphyt](https://epiph.yt/), your friendly neighborhood WordPress plugin shop from southern Germany. | |
| 44 | 46 | |
| 45 | -Please consult the [contributing guide](CONTRIBUTING.md) for detailed information. | |
| 46 | 47 | |
| 47 | -## Who are you, folks? | |
| 48 | +== Changelog == | |
| 48 | 49 | |
| 49 | -We are [Epiphyt](https://epiph.yt/en/), your friendly neighborhood WordPress plugin shop from southern Germany. | |
| 50 | += 1.0 = | |
| 51 | +* Initial release | |
| 50 | 52 | |
| 51 | -## Security | |
| 52 | - | |
| 53 | -For security related information, please consult the [security policy](SECURITY.md). | |
| 54 | - | |
| 55 | -## License | |
| 56 | - | |
| 57 | -Embed Privacy is free software, and is released under the terms of the GNU General Public License version 2 or (at your option) any later version. See [LICENSE.md](LICENSE.md) for complete license. | |
| 58 | - | |
| 53 | +== Upgrade Notice == | |
