Skip to content

Commit e86a2db

Browse files
committed
Polish readme for release
1 parent b9d6283 commit e86a2db

File tree

2 files changed

+55
-40
lines changed

2 files changed

+55
-40
lines changed

README.md

Lines changed: 54 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,39 @@ A collection of totally useful extra Shortcodes to make the life of Site Builder
44

55
![Builder Shortcode Extras plugin banner](https://raw.githubusercontent.com/deckerweb/builder-shortcode-extras/master/assets-repos/github-com/bse-banner.png)
66

7+
---
8+
9+
[Support Project](#support-the-project) | [Installation](#installation) | [Description](#description) | [Frequently Asked Questions](#frequently-asked-questions) | [Screenshots](#screenshots) | [Changelog](#changelog) | [Plugin Scope / Disclaimer](#plugin-scope--disclaimer)
10+
11+
---
12+
13+
## Support the Project
14+
15+
If you find this project helpful, consider showing your support by buying me a coffee! Your contribution helps me keep developing and improving this plugin.
16+
17+
Enjoying the plugin? Feel free to treat me to a cup of coffee ☕🙂 through the following options:
18+
19+
- [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W81BNTZE)
20+
- [Buy me a coffee](https://buymeacoffee.com/daveshine)
21+
22+
---
23+
24+
## Installation
25+
26+
**Quick Install**
27+
1. **Download ZIP:** [**builder-shortcode-extras.zip**](https://github.com/deckerweb/builder-shortcode-extras/releases/latest/download/builder-shortcode-extras.zip)
28+
2. Upload via WordPress Plugins > Add New > Upload Plugin
29+
3. There are no settings whatsover. Just start using the Shortcodes everywhere.
30+
4. Now enjoy displaying special stuff without coding and saving some time ;-)
31+
32+
33+
### Requirements
34+
35+
* WordPress version 6.7 or higher
36+
* PHP version 7.4 or higher
37+
* MySQL version 5.6 or higher
38+
39+
---
740

841
## Description
942

@@ -75,29 +108,7 @@ I was there, I know exactly how it feels at 02.00 a.m. in the middle of night. S
75108
* *Genesis Framework:* **`[bse-genesis-breadcrumbs]`** -- attributes: wrapper, class
76109
* **Note:** All these integrations are optional, only if the supported plugin or theme is installed and currently active. For the Block Editor there is smart logic in place recognizing popular "disable" plugins like "Classic Editor", "Disable Gutenberg" amongst others.
77110

78-
79-
## Installation
80-
81-
### Minimum Requirements
82-
83-
* WordPress version 4.7 or higher
84-
* PHP version 5.6.20 or higher
85-
* MySQL version 5.0 or higher
86-
87-
### We Recommend Your Host Supports at least:
88-
89-
* PHP version 7.2 or higher
90-
* MySQL version 5.6 or higher / OR MariaDB 10.1 or higher
91-
* HTTPS support
92-
93-
### Installation
94-
95-
1. Install using the WordPress built-in Plugin installer (via **Plugins > Add New** - search for `builder shortcode extras`), or extract the ZIP file and drop the contents in the `wp-content/plugins/` directory of your WordPress installation.
96-
2. Activate the plugin through the 'Plugins' menu in WordPress.
97-
3. There are no settings whatsover. Just start using the Shortcodes everywhere.
98-
4. Now enjoy displaying special stuff without coding and saving some time ;-)
99-
100-
111+
---
101112

102113
## Frequently Asked Questions
103114

@@ -161,19 +172,7 @@ Only if it makes sense, like the current Elementor Template Shortcode for exampl
161172

162173
If you have any suggestion for such a Shortcode, please feel free to [**open a new GitHub Issue**](https://github.com/deckerweb/builder-shortcode-extras/issues) in our development repository and tell us all about it. Thanks in advance!
163174

164-
165-
166-
### More info on Translations?
167-
168-
* English - default, always included
169-
* German (de_DE): Deutsch - immer dabei! :-)
170-
* For custom and update-safe language files please upload them to `/wp-content/languages/builder-shortcode-extras/` (just create this folder) - This enables you to use fully custom translations that won't be overridden on plugin updates. Also, complete custom English wording is possible with that as well, just use a language file like `builder-shortcode-extras-en_US.mo/.po` to achieve that (for creating one see the following tools).
171-
172-
**Easy WordPress.org plugin translation platform with GlotPress platform:** [**Translate "Builder Shortcode Extras"...**](https://translate.wordpress.org/projects/wp-plugins/builder-shortcode-extras)
173-
174-
*Note:* All my plugins are internationalized/ translateable by default. This is very important for all users worldwide. So please contribute your language to the plugin to make it even more useful. For translating and validating I recommend the awesome ["Poedit Editor"](https://www.poedit.net/), which works fine on Windows, macOS and Linux.
175-
176-
175+
---
177176

178177
## Screenshots
179178

@@ -216,12 +215,16 @@ If you have any suggestion for such a Shortcode, please feel free to [**open a n
216215
### 10. For Astra Pro: Shortcode for each Astra Custom Layout - great for reusage
217216
![For Astra Pro: Shortcode for each Astra Custom Layout - great for reusage](https://raw.githubusercontent.com/deckerweb/builder-shortcode-extras/master/assets-repos/wordpress-org/screenshot-10.png)
218217

219-
218+
---
220219

221220
## Changelog
222221

223-
### v1.1.0 – 2025...
224-
_Currently being worked on, stay tuned ..._
222+
### 🎉 v1.1.0 – March 2025
223+
* Bring back the plugin to a workable state
224+
* Removed all wordpress.org stuff
225+
* Removed the _DDWlib Plugin Installer Recommendations_ library got removed, it is no longer wanted/supported anyways
226+
* Removed own translations loader; WordPress now does it all itself; the packaged translations remain :)
227+
* **Note:** No longer in the .org plugin repo available – thanks to Matt... (I've taken it out myself as I have no longer interest in WordPress.org repo strategy) – just install it yourself via ZIP file, see above under "Installation"
225228

226229

227230
### 🎉 1.0.0 - 2019-09-10
@@ -240,4 +243,16 @@ Enjoy using *Builder Shortcode Extras*? **[Please consider making a donation](ht
240243

241244
---
242245

246+
## Plugin Scope / Disclaimer
247+
248+
This plugin comes as is.
249+
250+
_Disclaimer 1:_ So far I will support the plugin for breaking errors to keep it working. Otherwise support will be very limited. Also, it will NEVER be released to WordPress.org Plugin Repository for a lot of reasons (ah, thanks, Matt!).
251+
252+
_Disclaimer 2:_ All of the above might change. I do all this stuff only in my spare time.
253+
254+
_Most of all:_ Have fun building great sites!!! ;-)
255+
256+
---
257+
243258
Copyright © 2019–2025 David Decker – DECKERWEB.de

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@
1717
"source": "https://github.com/deckerweb/builder-shortcode-extras"
1818
},
1919
"require": {
20-
"php": ">=5.6.20"
20+
"php": ">=7.4"
2121
}
2222
}

0 commit comments

Comments
 (0)