Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added a better and more informative text of how the plugin works, and how it works out of the box.
  • Loading branch information
knofte authored Dec 19, 2023
1 parent 6ffe1bd commit 4b0668a
Showing 1 changed file with 58 additions and 17 deletions.
75 changes: 58 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,58 @@
=== Gravatar-alt-Tags ===
Contributors: knofte
Tags: gravatar, img, alt, tag, tags
Requires at least: 4.7
Tested up to: 5.4
Stable tag: 1.1
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

This plugins simply takes the name of the user and adds to the gravatar img alt tag.


== Changelog ==
= 1.2 =
* Initial setup
*
# Gravatar Alt Tags

Contributors: Kent Riboe
Tags: gravatar, img, alt, tag, tags
Requires at least: WordPress 4.7
Tested up to: WordPress 6.4.2
Stable tag: 1.1
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

A simple WordPress plugin that adds alt tags to Gravatar images for post authors and commenters, enhancing website accessibility and SEO.

## Description

Gravatar Alt Tags is a WordPress plugin designed to improve accessibility and SEO on your website by automatically adding alt tags to Gravatar images. The alt text is derived from the user's display name, ensuring that Gravatar images have descriptive and meaningful alt attributes. This is particularly useful for screen readers and search engines.

## Features

- Automatically adds alt tags to Gravatar images for both post authors and commenters.
- Uses the display name of registered users for the alt attribute.
- For comments made by unregistered users, the commenter's name is used as the alt text.
- Simple and lightweight, with no configuration needed.

## Installation

1. Download the plugin files from the GitHub repository.
2. Upload the plugin files to the `/wp-content/plugins/gravatar-alt-tags` directory, or install the plugin through the WordPress plugins screen directly.
3. Activate the plugin through the 'Plugins' screen in WordPress.

## Frequently Asked Questions

**Q: Does this plugin require any configuration?**
A: No, it works out of the box. Once activated, it will automatically start adding alt tags to Gravatar images.

**Q: Is this plugin compatible with all WordPress themes?**
A: This plugin should be compatible with most themes, but it may not work with themes that heavily customize Gravatar functions.

## Changelog

### 1.2
- Improved handling for both post authors and commenters' Gravatar images.
- Specific enhancements for managing Gravatars in comments, including support for registered and unregistered users.

### 1.1
- Initial release.

## Support

For support, feature requests, or bug reporting, please visit the [GitHub issues page](https://github.com/[YourGitHubUsername]/gravatar-alt-tags/issues).

## Contributions

Contributions to the plugin are welcome. Please visit the [GitHub repository](https://github.com/[YourGitHubUsername]/gravatar-alt-tags) to submit pull requests or suggest improvements.

## License

Gravatar Alt Tags is released under the GNU General Public License v2 or later. For more details, see the license file included with the plugin or visit [GNU General Public License v2.0](https://www.gnu.org/licenses/gpl-2.0.html).

0 comments on commit 4b0668a

Please sign in to comment.