-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathreadme.txt
59 lines (41 loc) · 3.05 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
=== AI Image Alt Text Generator with GPT-4o ===
Contributors: rafaucau
Donate link: https://github.com/android-com-pl/wp-ai-alt-generator?sponsor=1
Tags: alt text, accessibility, SEO, GPT-V, OpenAI
Requires at least: 6.6
Tested up to: 6.7
Requires PHP: 8.1
Stable tag: 2.5.1
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Plugin URI: https://github.com/android-com-pl/wp-ai-alt-generator
A WordPress plugin that leverages GPT-4o API to automatically generate descriptive and contextually relevant alt text for images.
== Description ==
Plugin that uses the OpenAI GPT-4o API to automatically generate alt text for images, either during the upload process or on-demand with a button. It enhances website accessibility and SEO by providing descriptive and relevant image descriptions.
Features:
- Bulk alt text generation for multiple images at once in media library and gallery block
- Manual generation via a button in the image block and media library
- Configurable automatic alt text generation during the upload process
== External Service Usage ==
This plugin relies on OpenAI's API, an external third-party service, to generate alt text for images. The plugin sends your images to OpenAI's API and receives generated alt text in return.
Before using this plugin, please review OpenAI's terms of use and privacy policy:
- OpenAI API Terms of Use: [https://openai.com/policies/terms-of-use](https://openai.com/policies/terms-of-use)
- OpenAI Privacy Policy: [https://openai.com/policies/privacy-policy](https://openai.com/policies/privacy-policy)
By using this plugin, you agree to OpenAI's terms and acknowledge that you have understood OpenAI's privacy policy.
== For Developers ==
You can read about the available hooks here: [https://github.com/android-com-pl/wp-ai-alt-generator?tab=readme-ov-file#for-developers](https://github.com/android-com-pl/wp-ai-alt-generator?tab=readme-ov-file#for-developers)
== Installation ==
1. Upload the plugin directory to your `/wp-content/plugins/` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress.
3. Go to `Settings -> Media` to configure the plugin settings.
4. Enter your OpenAI API key (you can find it in your [OpenAI account settings](https://platform.openai.com/api-keys)).
5. Alternatively, you can set your API key by defining the `ACPL_ALT_GENERATOR_OPENAI_API_KEY` constant in your wp-config.php file: `define('ACPL_ALT_GENERATOR_OPENAI_API_KEY', 'your-api-key-here');`. When the constant is defined, the API key field in the plugin settings will be disabled.
== Frequently Asked Questions ==
= Is there a cost associated with using this plugin? =
The plugin uses the OpenAI API, which will incur costs. Please check the [OpenAI pricing page](https://openai.com/pricing/) for details.
== Screenshots ==
1. Bulk alt text generation.
2. Generating alt text for an image in the media library.
3. Generating alt text automatically on upload.
== Changelog ==
For the plugin’s changelog, please see [the Releases page on GitHub](https://github.com/android-com-pl/wp-ai-alt-generator/releases).