Skip to content

Commit

Permalink
Update README and chanelog.
Browse files Browse the repository at this point in the history
  • Loading branch information
thefrosty committed Nov 15, 2023
1 parent e50a3d5 commit e927c86
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 28 deletions.
3 changes: 3 additions & 0 deletions CHANGELONG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## 2.0.0 - 2023-11-15
- Bump min PHP version to 8.0.

## 1.4.0 - 2019-01-03
### Updated
- `thefrosty/wp-utilties` to v^1.3.1.
Expand Down
49 changes: 21 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Dwnload EDD Software License Manager [![Build Status](https://travis-ci.org/dwnload/EddSoftwareLicenseManager.svg?branch=master)](https://travis-ci.org/dwnload/EddSoftwareLicenseManager)
# EDD Software License Manager

[![PHP from Packagist](https://img.shields.io/packagist/php-v/dwnload/edd-software-license-manager.svg)]()
[![Latest Stable Version](https://img.shields.io/packagist/v/dwnload/edd-software-license-manager.svg)](https://packagist.org/packages/dwnload/edd-software-license-manager)
[![Total Downloads](https://img.shields.io/packagist/dt/dwnload/edd-software-license-manager.svg)](https://packagist.org/packages/dwnload/edd-software-license-manager)
[![License](https://img.shields.io/packagist/l/dwnload/edd-software-license-manager.svg)](https://packagist.org/packages/dwnload/edd-software-license-manager)
![Build Status](https://github.com/dwnload/WpSettingsApi/actions/workflows/main.yml/badge.svg)
[![codecov](https://codecov.io/gh/dwnload/WpSettingsApi//branch/develop/graph/badge.svg)](https://codecov.io/gh/dwnload/WpSettingsApi/)

A PHP class abstraction for managing WordPress plugin licenses and auto-updates that are sold on an Easy Digital Downloads store.

## Package Installation (via Composer)
Expand All @@ -8,7 +16,7 @@ To install this package, edit your `composer.json` file:
```json
{
"require": {
"dwnload/edd-software-license-manager": "^1.3.0"
"dwnload/edd-software-license-manager": "^2.0"
}
}
```
Expand All @@ -20,31 +28,16 @@ Now run:
### How to use this package

```php
use Dwnload\EddSoftwareLicenseManager\Edd;

// In the root of your plugin
$args = [
'api_url' => trailingslashit( 'https://plugingarden.dwnload.io' ),
'plugin_file' => __FILE__,
'api_data' => [
'version' => (string) $version, // current version number
'license' => (string) $license_key, // license key (used get_option above to retrieve from DB)
'item_name' => 'Super Cool Plugin', // name of this plugin (matching your EDD Download title)
'item_id' => (int) 10,
'author' => 'Austin Passy', // author of this plugin
'beta' => (bool) isset( $use_beta ),
],
'item_id' => (int) 10,
'name' => plugin_basename( __FILE__ ),
'slug' => basename( __FILE__, '.php' ),
'version' => (string) $version,
'wp_override' => false,
'beta' => (bool) isset( $use_beta ),
$license = \get_option(\Dwnload\EddSoftwareLicenseManager\Edd\AbstractLicenceManager::LICENSE_SETTING, []);
$data = [
'license' => $license[$plugin_id]['license'] ?? '',
'item_name' => 'Custom Login Style Pack #1', // Name of this plugin (matching your EDD Download title).
'author' => 'Frosty Media',
'item_id' => (int),
'version' => '1.0.0',
];

if ( is_admin() ) {
( new Init() )
->add( new PluginUpdater( $args )
->initialize();
}
\TheFrosty\WpUtilities\Plugin\Plugin $plugin
->add(new Edd\LicenseManager($plugin, $data))
->add(new Edd\PluginUpdater('https://frosty.media/', __FILE__, $data))
->initialize();
```

0 comments on commit e927c86

Please sign in to comment.