Skip to content

Instantly share code, notes, and snippets.

@goldhat
Last active December 30, 2016 08:01
Show Gist options
  • Save goldhat/701151be2458e18e43e8e809f21d1987 to your computer and use it in GitHub Desktop.
Save goldhat/701151be2458e18e43e8e809f21d1987 to your computer and use it in GitHub Desktop.
Example ReadMe for WP plugins
=== ACF Option Pages ===
Contributors: goldhat
Donate link: https://goldhat.ca/donate/
Tags: acf, option pages, options
Requires at least: 4.0
Tested up to: 4.5
Stable tag: 1.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Provides ACF (Advanced Custom Fields) admin interface for creating option pages. Requires ACF Pro version.
== Description ==
Provides ACF (Advanced Custom Fields) admin interface for creating option pages. This enables easy creation of option pages which can then have ACF field groups associated with them to create a settings page, or custom control panel.
== Installation ==
= Minimum Requirements =
* WordPress 3.8 or greater
* ACF5 Pro
= Automatic installation =
Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of ACF Option Pages, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New.
In the search field type “ACF Option Pages” and click Search Plugins. Once you’ve found the ACF Option Pages plugin, click “Install Now”.
= Manual installation =
1. Upload the plugin files to the '/wp-content/plugins/plugin-name' directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Visit "Option Pages" tab in the WP Admin to add a new option page.
== Screenshots ==
1. Option Pages menu tab
2. Adding a new Options Page
3. Option to make an options subpage
4. Advanced settings, set menu position and icon
== Frequently Asked Questions ==
= Where can I get ACF5 Pro? =
Visit the ACF (Advanced Custom Fields) website at https://www.advancedcustomfields.com to purchase your license.
= What can options pages be used for? =
Option pages are often used to store settings for a theme or plugin. Anytime you need to store data, ACF Option Pages let you create the option pages where you can attach ACF Field Groups.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment