Update readme for all the plugins (#38)

* Update readme for all the plugins

* Clean up

* Add support for changelog pattern

* Add changeset for login and widget

.changeset/curly-pets-kneel.md

@@ -0,0 +1,6 @@
+---
+"wptelegram-widget": patch
+"wptelegram-login": patch
+---
+
+Fixed the block CSS not loaded in site editor

plugins/wptelegram-comments/src/readme.txt

@@ -38,66 +38,34 @@ For rules, see the pinned message. No spam please.
 * ⤴️ Users can reply to comments intuitively
 * ✏️ Comments can be edited or deleted anytime
 
-== Installation ==
-
-1. Upload the `wptelegram-comments` folder to the `/wp-content/plugins/` directory
-2. Activate the plugin through the Plugins menu in WordPress. After activation, you should see the menu of this plugin the the admin
-3. Configure the plugin.
-
-**Enjoy!**
-
 == Screenshots ==
 
 1. Settings
 
-== Changelog ==
-
-= 1.1.9 =
-- Maintenance release
-
-= 1.1.8 =
-- Fixed translations not loaded for some strings
-
-= 1.1.7 =
-- Fixed warnings in PHP 8.x
-
-= 1.1.6 =
-- Maintenance release
-
-= 1.1.5 =
-- Maintenance release
-
-= 1.1.4 =
-- Minor UI improvements
-
-= 1.1.3 =
-- Cleaned up the admin menu for single entry for WP Telegram
-- Fixed the ugly post type list when there are plenty of them
+== Installation ==
 
-= 1.1.2 =
-- Fixed the issue of settings not saved due to trailing slash redirects
+= Automatic installation =
 
-= 1.1.1 =
-- Fixed the wrong widget configuration being saved
+Automatic installation is the easiest way -- WordPress will handle the file transfer, and you won’t need to leave your web browser. To do an automatic install of the plugin:
+
+* Log in to your WordPress dashboard
+* Navigate to the Plugins menu, and click "Add New"
+* In the search field type "wptelegram-comments" and hit Enter
+* Locate the plugin in the list of search results
+* Click on "Install Now" and wait for the installation to complete
+* Click on "Activate"
 
-= 1.1.0 =
--   Switched to PHP namespaces
--   Refreshed and improved the UI
+= Manual installation =
 
-= 1.0.4 =
-- Fixed back-end validation for code
+Manual installation method requires downloading the plugin and uploading it to your web server via your favorite FTP application. The official WordPress documentation contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
 
-= 1.0.3 =
-- Add support for channel discussion scripts
+= Updating =
 
-= 1.0.2 =
-- Updated test up to
+Automatic updates should work smoothly, but we still recommend you back up your site.
 
-= 1.0.1 =
-* Added translations
-* Minor fixes
+== Changelog ==
 
-= 1.0.0 =
-* Initial Release
+= 1.1.9 =
+- Maintenance release
 
 [See full changelog](https://github.com/wpsocio/wptelegram-comments/blob/main/CHANGELOG.md)

plugins/wptelegram-login/src/readme.txt

@@ -111,16 +111,6 @@ Many thanks to the translators for doing a great job!
 
 * Note: You can also contribute to translating this plugin into your local language. Join the Chat (above)
 
-
-== Installation ==
-
-
-1. Upload the `wptelegram-login` folder to the `/wp-content/plugins/` directory
-2. Activate the plugin through the Plugins menu in WordPress. After activation, you should see the menu of this plugin the admin
-3. Configure the plugin.
-
-**Enjoy!**
-
 == Frequently Asked Questions ==
 
 = How to create a Telegram Bot =
@@ -133,7 +123,9 @@ Sorry, that's not possible because Telegram allows only a single button per page
 
 = I see "Bot domain invalid" message =
 
-Follow the instructions given on the settings page. You need to send `/setdomain` to @BotFather.
+Please follow the instructions given on the WP Telegram Login settings page.
+
+It looks like you missed one that says to send the <code>/setdomain</code> command to @BotFather.
 
 
 == Screenshots ==
@@ -148,30 +140,26 @@ Follow the instructions given on the settings page. You need to send `/setdomain
 8. User Profile (wp-admin)
 9. WooCommerce Account Page
 
-== Changelog ==
-
-= 1.10.7 =
-- Fixed the bug for Telegram Mini Apps which pass HTML encoded query string
-
-= 1.10.6 =
-- Fixed validation for Direct Link Mini Apps with start command
+== Installation ==
 
-= 1.10.5 =
-- Fixed validation for Direct Link Mini Apps
+= Automatic installation =
 
-= 1.10.4 =
-- Added Telegram Mini App login support
+Automatic installation is the easiest way -- WordPress will handle the file transfer, and you won’t need to leave your web browser. To do an automatic install of the plugin:
+
+* Log in to your WordPress dashboard
+* Navigate to the Plugins menu, and click "Add New"
+* In the search field type "wptelegram-login" and hit Enter
+* Locate the plugin in the list of search results
+* Click on "Install Now" and wait for the installation to complete
+* Click on "Activate"
 
-= 1.10.3 =
-- Fixed translations not loaded for some strings
+= Manual installation =
 
-= 1.10.2 =
-- Added Telegram user fields to WooCommerce Account page
+Manual installation method requires downloading the plugin and uploading it to your web server via your favorite FTP application. The official WordPress documentation contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
 
-= 1.10.1 =
-- Added language option for the login widget
+== Changelog ==
 
-= 1.10.0 =
-- Added support for Telegram Web App data authorization
+= 1.10.7 =
+- Fixed the bug for Telegram Mini Apps which pass HTML encoded query string
 
 [See full changelog](https://github.com/wpsocio/wptelegram-login/blob/main/CHANGELOG.md)

plugins/wptelegram-widget/src/readme.txt

@@ -142,25 +142,29 @@ Many thanks to the translators for the great job!
 
 * Note: You can also contribute in translating this plugin into your local language. Join the Chat (above)
 
+== Frequently Asked Questions ==
 
-== Installation ==
+= How to create a Telegram Bot =
 
+[How do I create a bot?](https://core.telegram.org/bots/faq#how-do-i-create-a-bot).
 
-1. Upload the `wptelegram-widget` folder to the `/wp-content/plugins/` directory
-2. Activate the plugin through the Plugins menu in WordPress. After activation, you should see the menu of this plugin the the admin
-3. Configure the plugin.
+= Why Legacy Widget shows nothing? =
 
-**Enjoy!**
+<em>Legacy Widget</em> <strong>does not show</strong> the <strong>old messages</strong>.
 
-== Frequently Asked Questions ==
+You need to post something new into the group/channel and wait for 5 minutes for the messages to appear.
 
-= How to create a Telegram Bot =
+If you are too impatient to wait for the results, open the URL under <strong>Tip!💡</strong> (below the instructions) in your browser.
 
-[How do I create a bot?](https://core.telegram.org/bots/faq#how-do-i-create-a-bot).
+<strong>Note:</strong> Please ensure to follow the instructions given on the settings page correctly.
 
-= Why Legacy Widget shows nothing? =
+= Why do I see my own website in the widget? =
+
+It means that there is something wrong with the permalinks on your website.
 
-Legacy Widget does not show the old messages. you need to post something new into the group/channel and wait for 5 minutes for the messages to appear. If you are too impatient to wait for the results 😄, then open the URL given under **Tip!** (below the instructions) in your browser.
+Simply goto wp-admin > Settings > <strong>Permalinks</strong> and just <em>Save Changes.</em>
+
+That should fix it. If it doesn't, please let us know at [@WPTelegramSupport](https://t.me/WPTelegramSupport).
 
 
 == Screenshots ==
@@ -175,64 +179,26 @@ Legacy Widget does not show the old messages. you need to post something new int
 8. Blocks
 9. Join Link View
 
-== Changelog ==
+== Installation ==
 
-= 2.1.11 =
-- Maintenance release
+= Automatic installation =
 
-= 2.1.10 =
-- Fixed translations not loaded for some strings
+Automatic installation is the easiest way -- WordPress will handle the file transfer, and you won’t need to leave your web browser. To do an automatic install of the plugin:
+
+* Log in to your WordPress dashboard
+* Navigate to the Plugins menu, and click "Add New"
+* In the search field type "wptelegram-widget" and hit Enter
+* Locate the plugin in the list of search results
+* Click on "Install Now" and wait for the installation to complete
+* Click on "Activate"
 
-= 2.1.9 =
-- Added caching for the widget content
+= Manual installation =
 
-= 2.1.8 =
-- Fixed warnings in PHP 8.x
+Manual installation method requires downloading the plugin and uploading it to your web server via your favorite FTP application. The official WordPress documentation contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
 
-= 2.1.7 =
-- Maintenance release
+== Changelog ==
 
-= 2.1.6 =
+= 2.1.11 =
 - Maintenance release
 
-= 2.1.5 =
-- Fixed PHP warning for `block_categories` deprecation
-
-= 2.1.4 =
-- Added lazy loading to iframes
-
-= 2.1.3 =
-- Added new tab option for join link
-
-= 2.1.2 =
-- Cleaned up the admin menu for single entry for WP Telegram
-
-= 2.1.1 =
-- Fixed the issue of settings not saved due to trailing slash redirects
-
-= 2.1.0 =
-- Added multi-channel support for Ajax Widget
-- Fixed the ugly URLs filter for widgets
-
-= 2.0.5 =
-- Fixed the admin menu and settings page icon
-
-= 2.0.4 =
-- Minor UI fixes for Join Link color picker
-
-= 2.0.3 =
-- Fixed the last messed up update
-
-= 2.0.2 =
-- Added color options to Join Link settings
-
-= 2.0.1 =
--   Fixed the issue with message order in legacy widget
-
-= 2.0.0 =
--   Switched to PHP namespaces
--   Added support for separate ajax and legacy widgets
--   Refreshed and improved the UI
--   Improved names for hooks and shortcodes
-
 [See full changelog](https://github.com/wpsocio/wptelegram-widget/blob/main/CHANGELOG.md)

plugins/wptelegram/src/readme.txt

@@ -108,15 +108,6 @@ Many thanks to the translators for the great job!
 
 Note: You can also contribute in translating this plugin into your local language. Join the Chat (above)
 
-
-== Installation ==
-
-1. Upload the `wptelegram` folder to the `/wp-content/plugins/` directory
-2. Activate the plugin through the Plugins menu in WordPress. After activation, you should see the menu of this plugin the the admin
-3. Configure the plugin.
-
-**Enjoy!**
-
 == Frequently Asked Questions ==
 
 = How to create a Telegram Bot? =
@@ -203,61 +194,30 @@ Yes, all you need to do is to setup **Private Notifications** module and use the
 12. Post Edit Page (Block Editor)
 13. Post Edit Page (Block Editor)
 
-== Changelog ==
-
-= 4.0.14 =
-- Added support for `<blockquote>` tag
-
-= 4.0.13 =
-- Fixed the failure of sending posts with large size images
-
-= 4.0.12 =
-- Fixed the Yoast Duplicated post not sent to Telegram
-
-= 4.0.11 =
-- Fixed translations not loaded for some strings
-
-= 4.0.10 =
-- Fixed the dollar sign getting nuked from excerpt
-- Fixed logs to avoid bot token added to URL
-
-= 4.0.9 =
-- Improved message template sanitization to prevent breaking the markup
-- Added a new filter `wptelegram_p2tg_post_data_plain_excerpt` to allow sending plain text excerpt
-- Fixed the links added in parenthesis when "Formatting" is set to "None"
-
-= 4.0.8 =
-- Fixed the broken hyperlinks in Message Template when using custom field link
+== Installation ==
 
-= 4.0.7 =
-- Fixed the issue of images being retained in post content links
+= Automatic installation =
 
-= 4.0.6 =
-- Fixed the issue of shortcodes being sent to Telegram
+Automatic installation is the easiest way -- WordPress will handle the file transfer, and you won’t need to leave your web browser. To do an automatic install of the plugin:
+
+* Log in to your WordPress dashboard
+* Navigate to the Plugins menu, and click "Add New"
+* In the search field type "wptelegram" and hit Enter
+* Locate the plugin in the list of search results
+* Click on "Install Now" and wait for the installation to complete
+* Click on "Activate"
 
-= 4.0.5 =
-- Fixed the unintended newlines in Post Excerpt and Post Content
+= Manual installation =
 
-= 4.0.4 =
-- Fixed repeated caption for the image when using the "After the text" option
-- Fixed the issue of long texts being truncated
+Manual installation method requires downloading the plugin and uploading it to your web server via your favorite FTP application. The official WordPress documentation contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
 
-= 4.0.3 =
-- Added support for adding internal note to chat IDs
+= Updating =
 
-= 4.0.2 =
-- Fixed PHP 8.1 issue with HTML conversion
+Automatic updates should work smoothly, but we still recommend you back up your site.
 
-= 4.0.1 =
-- Fixed the word count issue with non-english locales
+== Changelog ==
 
-= 4.0.0 =
-- Added better support for HTML formatting.
-- Added support for <u> and <ins> HTML tags.
-- Added support for nested tags. You can now use <b> inside <i> and vice versa.
-- Intelligently trim `{post_excerpt}` to preserve the other parts of Message Template.
-- Removed support for Markdown formatting in favour of better HTML formatting
-- Fixed the image not being sent "After the text" when "Send files by URL" is disabled
-- Fixed the issue of messages not being sent when the markup is not valid
+= 4.0.14 =
+- Added support for `<blockquote>` tag
 
 [See full changelog](https://github.com/wpsocio/wptelegram/blob/main/CHANGELOG.md)

tools/wpdev/src/commands/bundle.ts

@@ -234,11 +234,12 @@ export default class Bundle extends WithProjects<typeof Bundle> {
 							return task.skip();
 						}
 
-						const { readmeTxtFile } = bundle.tasks.updateChangelog;
+						const { readmeTxtFile, ...config } = bundle.tasks.updateChangelog;
 
 						return updateChangelog({
 							changesetJsonFile: this.flags['changeset-json'],
 							readmeTxtFile: path.join(project.dir, readmeTxtFile),
+							...config,
 							packageName: project.packageJson.name,
 							version,
 						});