Merge pull request #1 from duckdev/dev

Create v1.0.0

Author: Joel-James

README.md

@@ -1,2 +1,58 @@
-# Plugin Licensing
-A premium licensing module developed exclusively for Duck Dev plugins.
+# Freemius Plugin Licensing
+
+This is a lite version of the main Freemius SDK, specifically developed for use in Duck Dev WordPress plugins. This
+library focuses exclusively on managing plugin license activation, deactivation, and updates. It does not provide any
+user interface, so your plugin will need to create its own UI and use this library to handle the logic.
+
+## Requirements
+
+* PHP version 7.4 or higher.
+* WordPress 5.0+
+
+## Installation
+
+This library should be installed and included in your WordPress plugin using Composer.
+
+```console
+composer require duckdev/freemius-licensing-sdk
+```
+
+## Usage
+
+### Initialization
+
+Initialize the Freemius SDK by calling the static `DuckDev\Freemius\Freemius::get_instance()` method with your plugin's
+details.
+
+```php
+// Assuming Composer's autoload.php has been included.
+$freemius = DuckDev\Freemius\Freemius::get_instance(
+    12345, // Your Freemius product ID.
+    array(
+        'slug' => 'loggedin', // Your plugin's unique Freemius slug.
+	    'main_file'  => LOGGEDIN_FILE, // The path to your plugin's main file.
+        'public_key' => 'pk_XXXXXXXXXXXXXXXXX', // Your plugin's public key.
+    )
+);
+```
+
+### License Activation
+
+To activate a license, call the `activate()` method on the `license()` object with the user's license key.
+
+```php
+$freemius->license()->activate( 'XXXX-XXXX-XXXX' );
+```
+
+### License Deactivation
+
+To deactivate a license, simply call the `deactivate()` method.
+
+```php
+$freemius->license()->deactivate();
+```
+
+### Updates
+
+The library will automatically handle plugin updates as long as a valid license is active. No additional code is
+required to check for and apply updates.

composer.json

@@ -0,0 +1,35 @@
+{
+  "name": "duckdev/freemius-plugin-licensing",
+  "type": "library",
+  "description": "Lite version of the Freemius SDK for managing plugin licensing and updates using Freemius APIs, specifically developed for use with Duck Dev plugins.",
+  "keywords": [
+    "freemius",
+    "plugins",
+    "updates",
+    "licensing"
+  ],
+  "homepage": "https://github.com/duckdev/freemius-plugin-licensing",
+  "license": "GPL-2.0+",
+  "optimize-autoloader": true,
+  "authors": [
+    {
+      "name": "Joel James",
+      "email": "[email protected]",
+      "homepage": "https://duckdev.com",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "php": ">=7.4"
+  },
+  "config": {
+    "platform": {
+      "php": "7.4"
+    }
+  },
+  "autoload": {
+    "classmap": [
+      "src/"
+    ]
+  }
+}