Skip to content

Commit

Permalink
docs: update repo links, plugin name, and document use of external se…
Browse files Browse the repository at this point in the history
…rvice
  • Loading branch information
rafaucau committed Jan 9, 2024
1 parent 3b42005 commit 89f1c29
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 15 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@ effort.

## Installation

The plugin is currently awaiting approval on WordPress.org. In the meantime, you can download it from the [releases section on GitHub](https://github.com/android-com-pl/wp-gpt-vision-img-alt-generator/releases). Download the ZIP file and upload it to your website.
The plugin is currently awaiting approval on WordPress.org. In the meantime, you can download it from the [releases section on GitHub](https://github.com/android-com-pl/wp-ai-alt-generator/releases). Download the ZIP file and upload it to your website.

> [!IMPORTANT]
> The settings for the plugin are located in `Settings -> Media`.
> You need to enter your [OpenAI's API key](https://platform.openai.com/api-keys) there.
![wp-gpt-vision-img-alt-generator-2](https://github.com/android-com-pl/wp-gpt-vision-img-alt-generator/assets/25438601/a221655e-ab9e-4a74-97c0-f6359ec1741c)
![Generating manually](https://github.com/android-com-pl/wp-ai-alt-generator/assets/25438601/a221655e-ab9e-4a74-97c0-f6359ec1741c)

![wp-gpt-vision-img-alt-generator](https://github.com/android-com-pl/wp-gpt-vision-img-alt-generator/assets/25438601/d68179ad-4ed4-43b6-8d52-b2eeeb4b2534)
![Automatically generating on upload](https://github.com/android-com-pl/wp-ai-alt-generator/assets/25438601/d68179ad-4ed4-43b6-8d52-b2eeeb4b2534)

## Contributing

Pull requests are warmly welcomed! If you would like to contribute to the development of this plugin, please follow these steps:
Pull requests are welcomed!
If you would like to contribute to the development of this plugin, please follow these steps:

1. Fork the Repository: Start by forking the GitHub repository to your own account.
2. Clone Your Fork: Clone your forked repository to your local machine.
Expand Down
6 changes: 3 additions & 3 deletions acpl-ai-alt-generator.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php
/**
* @wordpress-plugin
* Plugin Name: GPT Vision Alt Text Generator
* Plugin Name: AI Alt Text Generator for GPT Vision
* Plugin URI: https://github.com/android-com-pl/wp-ai-alt-generator
* Description: Automatically generate alt text for images using OpenAI GPT Vision API.
* Version: 1.2.0
* Description: Automatically generate alternative text for images using OpenAI's GPT Vision API.
* Version: 2.0.0
* Requires at least: 6.3
* Requires PHP: 8.1
* Author: android.com.pl
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "acpl/wp-gpt-vision-img-alt-generator",
"name": "acpl/ai-alt-generator",
"type": "wordpress-plugin",
"autoload": {
"psr-4": {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "acpl_ai_alt_generator",
"name": "@acpl/ai-alt-generator",
"private": true,
"scripts": {
"build": "wp-scripts build",
Expand Down
22 changes: 16 additions & 6 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
=== GPT Vision Alt Text Generator ===
=== AI Alt Text Generator for GPT Vision ===
Contributors: rafaucau
Donate link: https://github.com/android-com-pl/wp-gpt-vision-img-alt-generator?sponsor=1
Donate link: https://github.com/android-com-pl/wp-ai-alt-generator?sponsor=1
Tags: alt text, accessibility, SEO, GPT-4, GPT-V, OpenAI, image
Requires at least: 6.3
Tested up to: 6.4
Requires PHP: 8.1
Stable tag: 1.2.0
Stable tag: 2.0.0
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Plugin URI: https://github.com/android-com-pl/wp-gpt-vision-img-alt-generator
Plugin URI: https://github.com/android-com-pl/wp-ai-alt-generator

A WordPress plugin that leverages GPT-4 API to automatically generate descriptive and contextually relevant alt text for images.

== Description ==

The GPT Vision Alt Text Generator is a WordPress plugin that uses the OpenAI GPT-4 Vision API to automatically generate alt text for images, either during the upload process or on-demand with a button. It enhances website accessibility, SEO, and user engagement by providing descriptive and relevant image descriptions. You can configure auto-generation on upload and manual generation via a button in the image block and media library.
Plugin that uses the OpenAI GPT-4 Vision API to automatically generate alt text for images, either during the upload process or on-demand with a button. It enhances website accessibility, SEO, and user engagement by providing descriptive and relevant image descriptions. You can configure auto-generation on upload and manual generation via a button in the image block and media library.

== 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.

== Installation ==

Expand All @@ -31,4 +41,4 @@ The plugin uses the OpenAI API, which will incur costs. Please check the [OpenAI

== Changelog ==

For the plugin’s changelog, please see [the Releases page on GitHub](https://github.com/android-com-pl/wp-gpt-vision-img-alt-generator/releases).
For the plugin’s changelog, please see [the Releases page on GitHub](https://github.com/android-com-pl/wp-ai-alt-generator/releases).

0 comments on commit 89f1c29

Please sign in to comment.