diff --git a/readme.txt b/readme.txt index 8adf1d1..85f84d5 100644 --- a/readme.txt +++ b/readme.txt @@ -1,115 +1,37 @@ -=== Tonys Sportspress Enhancements === -Contributors: (this should be a list of wordpress.org userid's) -Donate link: https://example.com/ -Tags: comments, spam -Requires at least: 4.5 -Tested up to: 6.5.3 -Requires PHP: 5.6 -Stable tag: 0.1.0 -License: GPLv2 or later -License URI: https://www.gnu.org/licenses/gpl-2.0.html +# Tony's SportsPress Enhancements -Here is a short description of the plugin. This should be no more than 150 characters. No markup here. +Suite of enhancements for the SportsPress plugin, including custom event permalinks, Open Graph tags, and automatic featured image generation for events. -== Description == +## Description -This is the long description. No limit, and you can use Markdown (as well as in the following sections). +Tony's SportsPress Enhancements is a collection of add-ons for the [SportsPress](https://wordpress.org/plugins/sportspress/) plugin. It provides: -For backwards compatibility, if this section is missing, the full length of the short description will be used, and -Markdown parsed. +- **Custom event permalinks** for `sp_event` post types, including season and team slugs. +- **Open Graph meta tags** for events, with dynamic titles, descriptions, and images. +- **Automatic featured image generation** for events, combining team colors and logos into a shareable image. -A few notes about the sections above: +## Features -* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames -* "Tags" is a comma separated list of tags that apply to the plugin -* "Requires at least" is the lowest version that the plugin will work on -* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on -higher versions... this is just the highest one you've verified. -* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for -stable. +- Custom rewrite rules and permalinks for SportsPress events. +- Open Graph integration for better social sharing. +- Dynamic, cached event images based on team data. +- Compatible with WordPress 4.5+ and PHP 5.6+. - Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so -if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used -for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt` -is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in -your in-development version, without having that information incorrectly disclosed about the current stable version -that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag. +## Installation - If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where -you put the stable version, in order to eliminate any doubt. +1. Upload the plugin files to the `/wp-content/plugins/tonys-sportspress-enhancements/` directory, or install via the WordPress plugin repository. +2. Activate the plugin through the 'Plugins' menu in WordPress. +3. Make sure the [SportsPress](https://wordpress.org/plugins/sportspress/) plugin is installed and activated. -== Installation == +## Frequently Asked Questions -This section describes how to install the plugin and get it working. +**Q: Does this plugin require SportsPress?** +A: Yes, it extends the functionality of the SportsPress plugin. -e.g. +**Q: How are event images generated?** +A: When an event is viewed or shared, a featured image is generated using the primary colors and logos of the participating teams. -1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory -1. Activate the plugin through the 'Plugins' menu in WordPress -1. Place `` in your templates -== Frequently Asked Questions == +--- -= A question that someone might have = - -An answer to that question. - -= What about foo bar? = - -Answer to foo bar dilemma. - -== Screenshots == - -1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from -the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets -directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` -(or jpg, jpeg, gif). -2. This is the second screen shot - -== Changelog == - -= 1.0 = -* A change since the previous version. -* Another change. - -= 0.5 = -* List versions from most recent at top to oldest at bottom. - -== Upgrade Notice == - -= 1.0 = -Upgrade notices describe the reason a user should upgrade. No more than 300 characters. - -= 0.5 = -This version fixes a security related bug. Upgrade immediately. - -== Arbitrary section == - -You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated -plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or -"installation." Arbitrary sections will be shown below the built-in sections outlined above. - -== A brief Markdown Example == - -Ordered list: - -1. Some feature -1. Another feature -1. Something else about the plugin - -Unordered list: - -* something -* something else -* third thing - -Here's a link to [WordPress](https://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. -Titles are optional, naturally. - -[markdown syntax]: https://daringfireball.net/projects/markdown/syntax - "Markdown is what the parser uses to process much of the readme file" - -Markdown uses email style notation for blockquotes and I've been told: -> Asterisks for *emphasis*. Double it up for **strong**. - -`` +*This plugin is not affiliated with or endorsed by ThemeBoy or the official SportsPress plugin.* \ No newline at end of file diff --git a/tonys-sportspress-enhancements.php b/tonys-sportspress-enhancements.php index fc426f7..d1ed59d 100644 --- a/tonys-sportspress-enhancements.php +++ b/tonys-sportspress-enhancements.php @@ -7,7 +7,7 @@ * Author URI: YOUR SITE HERE * Text Domain: tonys-sportspress-enhancements * Domain Path: /languages - * Version: 0.1.0 + * Version: 0.1.1 * * @package Tonys_Sportspress_Enhancements */