Skip to content

Commit c656b40

Browse files
committed
docs: update readme.txt
1 parent 588c64f commit c656b40

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

readme.txt

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,53 @@
1-
=== Blablablocks Formats ===
1+
=== BlaBlaBlocks Formats ===
22
Contributors: lubus, ajitbohra, punitv342, nagpai
33
Tags: format, rich text format, BlaBlaBlocks
44
Requires at least: 6.6
55
Tested up to: 6.8
66
Requires PHP: 7.4
7-
Stable tag: 1.0
7+
Stable tag: 1.0.0
88
License: MIT
99
License URI: https://www.gnu.org/licenses/MIT
1010

1111
Interactive rich text formats for the WordPress block editor.
1212

1313
== Description ==
14-
A collection of rich text formats for the WordPress block editor with interactive elements. Starting with InfoTip tooltips and Marker highlights. More to come in the future!
14+
A collection of rich text formats for the WordPress block editor with interactive elements.
1515

1616
=== What makes BlaBlaBlocks Formats special? ===
1717
* **Simple usage** - Add interactive tooltips and animated highlights with the ease of adding any simple text format.
1818
* **More control** - A variety of customization possible in behavior, colors and animation for each format
1919
* **Editor Compatibility** – fully integrated with the Block Editor’s UI and server-side rendering pipeline.
2020

21-
== Screenshots ==
22-
( TODO add screenshots )
21+
=== Open Source and Free ===
22+
The BlaBlaBlocks Formats is open source. Not only is it free to use, but you are also welcome to collaborate and contribute to its development.
23+
24+
- **Source Code:**
25+
[https://github.com/lubusIN/blablablocks-formats](https://github.com/lubusIN/blablablocks-formats)
2326

27+
- **Report Issues:**
28+
[https://github.com/lubusIN/blablablocks-formats/issues](https://github.com/lubusIN/blablablocks-formats/issues)
29+
30+
== Screenshots ==
2431
1. **Marker settings** - Select and adjust Marker type and settings.
25-
2. **InfoTip settings** - Add InfoTip text and adjust settings.
26-
3. **Frontend view of Marker**
32+
2. **Frontend view of Marker**
33+
3. **InfoTip settings** - Add InfoTip text and adjust settings.
2734
4. **Frontend view of InfoTip**
2835

2936
== Installation ==
30-
1. Download the latest release from GitHub ( TODO - add link to latest release )
31-
2. Browse to `WP Admin > Plugins > Add New`
32-
3. Upload the `blablablocks-formats.zip` file
33-
4. Activate `BlaBlaBlocks Formats` from the plugins page
37+
You can install this plugin either automatically through the WordPress admin or manually via FTP.
38+
39+
= Automatic Installation =
40+
41+
1. Log in to your WordPress dashboard.
42+
2. Navigate to Plugins > Add New.
43+
3. In the search field, type “BlaBlaBlocks Formats, then hit Enter or click Search Plugins.
44+
4. Click Install Now, then Activate.
45+
46+
= Manual Installation =
47+
48+
Manual installation method requires downloading the BlaBlaBlocks Formats plugin and uploading it to your web server via your favorite FTP application. The WordPress codex contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
3449

3550
== Changelog ==
3651

3752
= 1.0.0 =
38-
* Initial release 🎉
39-
* InfoTip format - Add customizable tooltips to any text in the editor.
40-
* Marker format - Add customizable animated or static text highlights.
53+
Initial release 🎉

0 commit comments

Comments
 (0)