Skip to content

Commit

Permalink
docs: add installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaucau committed Nov 8, 2023
1 parent 96c311e commit 3ea1869
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
# GPT-Powered Alt Text Generator for WordPress

## 🚧 Work in Progress

WordPress plugin that uses the GPT-4 API to automatically generate descriptive and contextually relevant alt text for
images during the upload process. This plugin is designed to enhance website accessibility and improve SEO with minimal
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.

> [!IMPORTANT]
> The settings for the plugin are located in `Settings -> Media`.
> You need to enter your [OpenAI API key](https://platform.openai.com/api-keys) there.
![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)

![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)

## TODO:

- [x] Add settings page
- [x] Generate alt on upload option
- [x] Generate alt button
- [x] Error handling
- [ ] Upload to WordPress.org

0 comments on commit 3ea1869

Please sign in to comment.