-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
111 lines (82 loc) · 5.28 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
=== AI + Block Editor ===
Contributors: badasswp
Tags: ai, block, editor, chat-gpt, assistant.
Requires at least: 6.0
Tested up to: 6.7.1
Stable tag: 1.1.2
Requires PHP: 7.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Add AI Capabilities to the Block Editor. Generate Captions/Headlines, Summaries, Slugs, SEO Keywords using our amazing plugin.
== Installation ==
1. Go to <strong>Plugins > Add New</strong> on your WordPress admin dashboard.
2. Search for <strong>AI + Block Editor</strong> plugin from the official WordPress plugin repository.
3. Click 'Install Now' and then 'Activate'.
4. To get started, you would need to have an API key from your API Provider. For e.g. Open AI is <a href="https://platform.openai.com/api-keys">https://platform.openai.com/api-keys</a>.
5. If you have gotten your API key, you should save it into your plugin options page.
6. Make sure to enable the checkbox for your API Provider for e.g. <strong>Enable Open AI</strong> or any other as applicable to you.
7. That's it! You're all set to start using AI.
== Description ==
Add AI Capabilities to the Block Editor.
Generate <strong>Captions/Headlines</strong>, <strong>Summaries</strong>, <strong>Slugs</strong>, <strong>SEO Keywords</strong> using our amazing plugin. It is fast and very useful for users who need to quickly generate high-quality content with minimal effort. Whether you're a <strong>blogger</strong>, <strong>editor</strong>, or <strong>content creator</strong>, our plugin helps streamline your workflow by providing intelligent suggestions that enhance readability and SEO performance.
Save time and improve engagement with AI-powered insights directly within the WordPress block editor.
= ✔️ Features =
Our plugin comes with everything you need to add AI capabilities to your Block Editor.
✔️ <strong>Change Text Tone (casual, official, narrative, and so on...)</strong> in block editor.
✔️ <strong>Generate Title/Headline</strong> using AI.
✔️ <strong>Generate Summary/Excerpts</strong>.
✔️ <strong>Generate SEO friendly URL Slugs</strong> for your post articles.
✔️ <strong>Generate SEO Keywords</strong> to help with SEO optimisation.
✔️ <strong>Custom Filters</strong> to help user <strong>modify AI prompts</strong>.
✔️ <strong>Shortcut Keys</strong> - CMD + SHIFT + A + I.
✔️ Available in <strong>mutiple langauges</strong> such as Arabic, Chinese, Hebrew, Hindi, Russian, German, Italian, Croatian, Spanish & French languages.
✔️ <strong>Backward compatible</strong>, works with most WP versions.
= ✨ Getting Started =
1. To get started, you would need to have an API key from your API Provider. For e.g. Open AI is <a href="https://platform.openai.com/api-keys">https://platform.openai.com/api-keys</a>.
2. If you have gotten your API key, you should save it into your plugin options page.
3. Make sure to enable the checkbox for your API Provider for e.g. <strong>Enable Open AI</strong> or any other as applicable to you.
You can get a taste of how this plugin works, by using the [demo](https://tastewp.com/create/NMS/8.0/6.7.0/ai-plus-block-editor/twentytwentythree?ni=true&origin=wp) link.
= 🔌🎨 Plug and Play or Customize =
The AI Plus Block Editor plugin is built to work right out of the box. Simply install, activate and start using.
Want to add your personal touch? All of our documentation can be found [here](https://github.com/badasswp/ai-plus-block-editor). You can override the plugin's behaviour with custom logic of your own using [hooks](https://github.com/badasswp/ai-plus-block-editor?tab=readme-ov-file#hooks).
== Screenshots ==
1. Change Text Tone - AI Capabilities added to the Block editor's Toolbar.
2. Headline, Summary, Slug, Keywords - AI Capabilities added to the Block editor's Sidebar.
3. Options Page - Add API keys and select AI Provider.
4. Sidebar Icon - Locate AI Sidebar feature on the top-right corner of screen.
== Changelog ==
= 1.1.2 =
* Refactor: AI client instance, make interchangeable.
* Fix: Minor syntax typos.
* Chore: Updated README notes.
* Test: Add more unit tests.
* Tested up to WP 6.7.1.
= 1.1.1 =
* Fix: Resolved issues with onChange handler for AiSidebar fields.
* Fix: Resolved issues with front slashed slug.
* Fix: Resolved issue with deprecation warnings - nextHasNoMarginBottom.
* Fix: Resolved issue related to null object on: editor-post-title update.
* Fix: Resolved issue with dependency conflict `wp-edit-site`.
* Chore: Updated build ignore list.
* Chore: Updated README notes.
* Tested up to WP 6.7.1.
= 1.1.0 =
* Feat: Added Headline, Summary, Slug, Keywords feature.
* Feat: Added AI sidebar.
* Feat: Introduced Post meta features for Articles.
* Feat: Implemented custom filters `apbe_tone_prompt`, `apbe_feature_prompt` & `apbe_rest_routes`.
* Tested up to WP 6.7.1.
= 1.0.1 =
* Reference assets directly using `plugin_dir_url`.
* Upgrade CI/CD build to Node 20.
* Update custom filter prefix `apbe_form_fields`.
* Tested up to WP 6.7.1.
= 1.0.0 =
* Add AI tone capabilities to toolbar.
* Add custom plugin options page.
* Add Unit Tests.
* Update README notes.
* Tested up to WP 6.7.1.
== Contribute ==
If you'd like to contribute to the development of this plugin, you can find it on [GitHub](https://github.com/badasswp/ai-plus-block-editor).
To build, clone repo and run `yarn install && yarn build`