From 2499c40d2e7484619d14a0dbb03ec76cac31791b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Spryszak?= <4544831-lusp@users.noreply.gitlab.com> Date: Wed, 15 Jun 2022 13:04:31 +0000 Subject: [PATCH] chore(readme): description fixes --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 946a25d..351a713 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,14 @@ [](https://packagist.org/packages/wpdesk/wp-basic-requirements) [](https://packagist.org/packages/wpdesk/wp-basic-requirements) -WP Basic Requirements -===================== +# WP Basic Requirements -Wp-basic-requirements is a simple library for WordPress plugins to check if the environment meets the requirements -and if the requirements are not met shows proper notice to user. +wp-basic-requirements is a simple library for WordPress plugins allowing to verify if the target environment meets the defined requirements. If not, it can be also used to display the notice to the users containing the proper information. -Library have to be compatible with PHP 5.2.x as it's the lowest possible version for WordPress. +The library has to be compatible with PHP 5.2.x since it's the oldest acceptable version for WordPress to be run. + +Available requirements to be defined: -Requirements may be: - Minimal PHP version - Minimal WordPress version - Minimal WooCommerce version @@ -35,7 +34,7 @@ composer require wpdesk/wp-basic-requirements ## Example usage -Use this code in main WordPress plugin file: +Use the following code in WordPress plugin's main .php file: ```php <?php -- GitLab