Initial commit.

lib/wp-package-updater/README.md

@@ -0,0 +1,67 @@
+# WP Package Updater - Plugins and themes update library
+
+### Description
+
+Used to enable updates for plugins and themes distributed via WP Plugin Update Server.
+
+### Requirements
+
+The library must sit in a `lib` folder at the root of the plugin or theme directory.
+
+Before deploying the plugin or theme, make sure to change the following value:
+- `https://your-update-server.com`  => The URL of the server where WP Plugin Update Server is installed.
+- `$prefix_updater`                 => Change this variable's name with your plugin or theme prefix
+
+### Code to include in main plugin file
+
+#### Simple update
+
+```php
+require_once plugin_dir_path( __FILE__ ) . 'lib/wp-package-updater/class-wp-package-updater.php';
+
+$prefix_updater = new WP_Package_Updater(
+  'https://your-update-server.com',
+  wp_normalize_path( __FILE__ ),
+  wp_normalize_path( plugin_dir_path( __FILE__ ) ),
+);
+```
+
+#### Update with license check
+
+```php
+require_once plugin_dir_path( __FILE__ ) . 'lib/wp-package-updater/class-wp-package-updater.php';
+
+$prefix_updater = new WP_Package_Updater(
+  'https://your-update-server.com',
+  wp_normalize_path( __FILE__ ),
+  wp_normalize_path( plugin_dir_path( __FILE__ ) ),
+  true
+);
+```
+
+### Code to include in functions.php
+
+#### Simple update
+
+```php
+require_once get_stylesheet_directory() . '/lib/wp-package-updater/class-wp-package-updater.php';
+
+$prefix_updater = new WP_Package_Updater(
+  'https://your-update-server.com',
+  wp_normalize_path( __FILE__ ),
+  get_stylesheet_directory(),
+);
+```
+
+#### Update with license check
+
+```php
+require_once get_stylesheet_directory() . '/lib/wp-package-updater/class-wp-package-updater.php';
+
+$prefix_updater = new WP_Package_Updater(
+  'https://your-update-server.com',
+  wp_normalize_path( __FILE__ ),
+  get_stylesheet_directory(),
+  true
+);
+```