Skip to content

Commit 024d945

Browse files
committed
Update readme
#14
1 parent 7a8bb4c commit 024d945

File tree

2 files changed

+40
-3
lines changed

2 files changed

+40
-3
lines changed

readme.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
11
# EDD Software Licensing SDK
22

3+
A drop-in solution for WordPress plugin and theme developers to quickly integrate Easy Digital Downloads Software Licensing into their products without complex setup or custom admin interfaces.
4+
5+
## Overview
6+
7+
The EDD Software Licensing SDK streamlines the process of adding licensing functionality to your WordPress plugins and themes. Instead of building custom settings pages and handling license validation manually, this SDK provides a complete licensing solution that seamlessly integrates with existing WordPress admin interfaces.
8+
9+
### Key Features
10+
11+
- **Zero-configuration licensing** - Add licensing support with just a few lines of code
12+
- **Native WordPress integration** - License fields appear directly in plugin action links and theme admin menus
13+
- **Automatic updates** - Handles secure update delivery for licensed products
14+
- **No custom admin pages** - Uses WordPress's existing interface patterns
15+
- **Flexible deployment** - Works as a standalone plugin or Composer package
16+
- **Developer-friendly** - Minimal code required, maximum functionality provided
17+
18+
### How It Works
19+
20+
For **plugins**, the SDK adds a "Manage License" link directly in the plugin list on the Plugins admin screen. Clicking this link opens a modal where users can enter and activate their license key.
21+
22+
For **themes**, a "Theme License" menu item is automatically added to the Appearance menu, providing easy access to license management via the modal.
23+
24+
The SDK handles all the complex licensing logic behind the scenes:
25+
- License key validation and activation
26+
- Automatic update notifications and delivery
27+
- License status tracking and renewal reminders
28+
- Secure communication with your EDD store
29+
30+
### Perfect For
31+
32+
- Plugin developers who want to focus on features, not licensing infrastructure
33+
- Theme authors looking for a professional licensing solution
34+
- Developers transitioning from other licensing systems
35+
- Anyone who wants licensing integration without reinventing the wheel
36+
37+
## Installation
38+
339
You can run the SDK as a standalone plugin on your site, or install it as a Composer package in your theme or plugin:
440

541
```
@@ -17,7 +53,7 @@ You can run the SDK as a standalone plugin on your site, or install it as a Comp
1753
}
1854
}
1955
20-
## Example Usage
56+
### Example Usage
2157
2258
Plugin:
2359
```php
@@ -55,11 +91,12 @@ add_action(
5591
);
5692
```
5793

58-
## Arguments
94+
### Arguments
5995

6096
- `id` - Plugin/theme slug.
6197
- `url` - The store URL.
6298
- `item_id` - The item ID (on your store).
6399
- `version` - The current version number.
64100
- `file` - The main plugin file. Not needed for themes.
65101
- `type` - `plugin` or `theme`. Not needed for plugins.
102+
- `weekly_check` - Optional: whether to make a weekly request to confirm the license status. Defaults to true.

src/Updaters/Updater.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ abstract class Updater {
4949
*/
5050
public function __construct( $api_url, $args = array() ) {
5151
$this->api_url = $api_url;
52-
$this->file = $args['file'];
52+
$this->file = $args['file'] ?? '';
5353
$defaults = $this->get_api_request_defaults();
5454
$this->args = array_merge( $defaults, array_intersect_key( $args, $defaults ) );
5555
$this->add_listeners();

0 commit comments

Comments
 (0)