From 03f0aecfc6279e096e7ce655d7bd256d78910727 Mon Sep 17 00:00:00 2001
From: Nerijus Zaniauskas <nerijus.z@omnisend.com>
Date: Tue, 2 Jan 2024 14:28:04 +0200
Subject: [PATCH] Add README.md

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6eac847
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Omnisend Core Plugin
+
+## PHP Linting
+
+WordPress.org team mandates our plugin to be linted
+against [WordPress coding standards](https://github.com/WordPress/WordPress-Coding-Standards).
+
+After each push to any branch `PHP Standards` action will run and all the PHP code will be linted. See action output for results.
+
+### Linting locally
+
+Tools needed:
+
+-   php (7.4 version is recommended because at the time of writing WordPress coding standards supports only up to 7.4 version);
+-   composer (can be installed as described in https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos);
+
+After installing those tools one can run in local plugin dir (plugin_woocommerce_api) helper script:
+
+```shell
+./lint.sh check
+./lint.sh fix
+```
+
+or all commands manually. Following commands
+
+```shell
+composer update
+composer install
+```
+
+install linting tool and standards. And then actual linting `phpcs` script can be initiated with
+
+```shell
+./vendor/squizlabs/php_codesniffer/bin/phpcs --ignore=.js --standard=WordPress omnisend-connect
+```
+
+A second `phpcbf` script can be run to automatically correct coding standard violations:
+
+```shell
+./vendor/squizlabs/php_codesniffer/bin/phpcbf --ignore=.js --standard=WordPress omnisend-connect
+```