Skip to content

Commit fb983af

Browse files
author
Jan Karres
committed
docs: rewrite plugin description #4af6j9
1 parent 010fc4a commit fb983af

File tree

1 file changed

+51
-31
lines changed

1 file changed

+51
-31
lines changed

README.md

Lines changed: 51 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,89 @@
11
=== WP/LR Sync Folders ===
2-
Contributors: mguenter, TigrouMeow
3-
Tags: lightroom, image, gallery, media, photo, export, management, admin, sync, synchronization, real media library, add-on, wplr-extension
2+
Contributors: devowl, mguenter, TigrouMeow
3+
Tags: wp/lr sync, lightroom sync, real media library, lightroom, synchronization, sync, export, image, gallery, photo, management, wplr-extension
44
Requires at least: 4.4
55
Requires PHP: 5.4.0
66
Tested up to: 5.4
77
Stable tag: trunk
88

9-
Displays the hierarchy of folders and collections nicely on the left side of your Media Library by syncing with the Real Media Library plugin.
9+
Synchronize your folders and collections in Real Media Library (Media Library Folders for WordPress) with Lightroom (with the help of WP/LR Sync).
1010

1111
== Description ==
12-
Synchronize your photos, collections, keywords and metadata between Lightroom and WordPress Real Media Library. Any changes in your Lightroom will be replicated in your WordPress media library folder structure.
12+
Synchronize your photos, collections, keywords, and metadata between Lightroom and [WordPress Real Media Library](https://devowl.io/wordpress-real-media-library/). All changes in your Lightroom are replicated in the folder structure of your WordPress Media Library.
1313

14-
**INSTALLATION**. This plugin requires the WP/LR Sync plugin for Lightroom and WordPress Real Media Library. They are available here: [WP/LR Sync at Meow Apps](https://meowapps.com/wplr-sync) and [WP Real Media Library](https://codecanyon.net/item/wordpress-real-media-library-media-categories-folders/13155134).
14+
== Requirements =
1515

16-
**GALLERIES BASED ON YOUR LIGHTROOM COLLECTIONS**. When the Lightroom hierarchy and attachments are synced with your WordPress installation you are able to generate dynamic galleries on your posts and pages.
16+
This plugin is an add-on that allows you to use the following plugins together, which must be installed:
1717

18-
**Main features:**
19-
- Add folders / collections automatically
20-
- Remove and move folders / collections automatically
21-
- Put an image in multiple collections
22-
- Respect LR image order
23-
- Own folder Icons in your folder structure
18+
- [WP/LR Sync](https://meowapps.com/wplr-sync)
19+
- [Real Media Library](https://devowl.io/go/codecanyon/real-media-library?source=wp-lr-sync-folders-wordpress-org)
2420

25-
Official WP/LR FAQ: [here](https://meowapps.com/wplr-sync/faq). If you are a developer you can have a look at the GitHub repository for this Add-On [here](https://github.com/matzeeable/wplr-rml).
21+
=== Features ===
22+
23+
- Add folders/collections automatically
24+
- Remove and move folders/collections automatically
25+
- Inserting an Image into multiple collections
26+
- Respect the Lightroom image order
27+
- Custom folder icons in your folder structure
28+
- Galleries based on your Lightroom collections: When the Lightroom hierarchy and attachments are synchronized with your WordPress installation, you can generate dynamic galleries on your posts and pages
29+
30+
== Further links ==
31+
32+
If you want to learn more, have a problem or if you are a developer, the following links are for you:
33+
34+
- [WP/LR FAQ](https://meowapps.com/wplr-sync/faq)
35+
- [Real Media Library Knowledge Base](https://help.devowl.io/kb/real-media-library)
36+
- [devowl.io support (for Real Media Library and this plugin)](https://devowl.io/support/)
37+
- [Git repository of WP/LR Sync Folders at GitHub](https://github.com/matzeeable/wplr-rml)
2638

2739
== Installation ==
2840

29-
1. Upload `wplr-rml` to the `/wp-content/plugins/` directory
30-
2. Activate the plugin through the 'Plugins' menu in WordPress
31-
3. Install the Lightroom plugin from here: https://meowapps.com/wplr-sync
32-
4. Install the WP Real Media Library plugin from: [WP Real Media Library](https://codecanyon.net/item/wordpress-real-media-library-media-categories-folders/13155134)
33-
5. Synchronize everything :)
41+
1. Go to your WordPress backend
42+
2. Navigate to "Plugins" > "Add New"
43+
3. Search for "WP/LR Sync Folders"
44+
4. Install and activate the plugin
45+
5. Install [WP/LR Sync from Meow Apps](https://meowapps.com/wplr-sync)
46+
6. Install [Real Media Library from devowl.io](https://devowl.io/go/codecanyon/real-media-library?source=wp-lr-sync-folders-wordpress-org)
47+
7. Synchronize everything :)
3448

3549
== Frequently Asked Questions ==
36-
= I used the previous Real Media Library extension =
37-
If you have used already the built-in WP Real Media Library extension you navigate to `WP/LR Sync` > `Extensions`. Make sure you have still ticked "Real Media Library" in extensions and click the button `Reset with Extensions`. This does remove all the RML folders which where already synced with your media library (it does not delete attachments from WP itself). Afterwards untick the RML extension, save, activate the `WP/LR Sync Folders` plugin and do `Resync with Extensions`.
3850

3951
= Total Sync shows shortcut as not linked =
40-
If you use Total Sync it shows shortcuts as unlinked. Do not worry about this - a LR id may only be associated with one attachment within WordPress.
52+
When you use Total Sync, it shows shortcuts as unlinked. Don't worry about this - a Lightroom ID can only be linked to one attachment in WordPress.
4153

4254
= I see a lot of shortcuts, how can I delete them? =
43-
The extension creates shortcuts only when necessary. That means a shortcut is created when an image is put into multiple collections. But if you want to delete them make sure you have Real Media Library and this extension active: Navigate to Settings > Media Tab "Reset" and click "Delete WP/LR shortcuts".
55+
The extension only creates links when necessary. This means that a shortcut is created when an image is added to multiple collections. However, if you want to delete it, make sure that the Real Media Library and this extension are active: Navigate to Settings > Media "Reset" tab and click "Delete WP/LR Shortcuts".
4456

4557
== Changelog ==
4658

4759
= 1.1.2 =
48-
* Prepare for Real Media Librar v4.6
60+
61+
- Prepare for Real Media Library v4.6
62+
- Updated plugin description
4963

5064
= 1.1.1 =
51-
* Show migration message only when previously used an older version of the plugin
65+
66+
- Show migration message only when previously used an older version of the plugin
5267

5368
= 1.1 =
54-
* Real Media Library v4.0.10 is now required as minimum version
55-
* Fixed the synchronization mechanism and create only shortcuts when needed (see https://github.com/matzeeable/wplr-rml/issues/2)
69+
70+
- Real Media Library v4.0.10 is now required as minimum version
71+
- Fixed the synchronization mechanism and create only shortcuts when needed (see https://github.com/matzeeable/wplr-rml/issues/2)
5672

5773
= 1.0.2 =
58-
* PHP 5.4 is now the minimum required PHP version
59-
* Prepared compatibility with Real Physical Media
74+
75+
- PHP 5.4 is now the minimum required PHP version
76+
- Prepared compatibility with Real Physical Media
6077

6178
= 1.0.1 =
62-
* Fixed bug with custom sorting issues
79+
80+
- Fixed bug with custom sorting issues
6381

6482
= 1.0 =
65-
* First release.
83+
84+
- First release.
6685

6786
== Screenshots ==
87+
6888
1. The Lightroom publish services...
69-
2. ... is automatically synchronized with your Media Library
89+
2. ...is automatically synchronized with your media library

0 commit comments

Comments
 (0)