From 3ea186958327346920bad6e6e326c102b74841a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Ca=C5=82ka?= Date: Wed, 8 Nov 2023 13:26:08 +0100 Subject: [PATCH] docs: add installation section --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 11a18e9..e98e22c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # 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. @@ -13,11 +15,3 @@ effort. ![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