Skip to content

Commit

Permalink
Recommend the Custom TGMPA Generator as the preferred download method.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrfnl committed Feb 12, 2016
1 parent 86f1d73 commit 86acb2b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Expand Up @@ -16,16 +16,20 @@ TGM Plugin Activation is a PHP library that allows you to easily require or reco

## Installation

1. Head to the [Releases](https://github.com/TGMPA/TGM-Plugin-Activation/releases) page and download the latest release zip.
1. Generate a customized version of the latest version of TGMPA based on your intended use-case using the [Custom TGMPA Generator](http://tgmpluginactivation.com/download/).
2. Extract the class file and place it somewhere in your theme hierarchy.
3. Add a `require_once` call within `functions.php` (or other theme file) referencing the class file.
3. Add a `require_once` call within `functions.php` (or other file) referencing the class file.
4. Create a function, hooked to `tgmpa_register`, that registers the plugin and configurations.

For steps 3 and 4, it is recommended you view, copy and paste the contents of `example.php`
and amend to suit. The `example.php` file is a model for how you should include the class in your theme.

Detailed documentation on [how to configure TGMPA](http://tgmpluginactivation.com/configuration/) is available on the website.

__*We strongly recommend the use of the [Custom TGMPA Generator](http://tgmpluginactivation.com/download/) if you intend to use TGMPA in a theme which is to be published via WordPress.org or Themeforest.*__

The generated customized version of TGMPA will comply with the Theme Review guidelines and Theme Check.

### Composer

TGM Plugin Activation is also available as a [package](https://packagist.org/packages/tgmpa/tgm-plugin-activation) installable via Composer:
Expand Down

0 comments on commit 86acb2b

Please sign in to comment.