From 7a3603748fd9a2267f9eb74b21fb4a04779c2b73 Mon Sep 17 00:00:00 2001
From: Bart Jaskulski <bjaskulski@protonmail.com>
Date: Fri, 17 Nov 2023 14:51:10 +0100
Subject: [PATCH] chore: add readme and changelog

Signed-off-by: Bart Jaskulski <bjaskulski@protonmail.com>
---
 CHANGELOG.md |  4 ++++
 README.md    | 19 +++++++++++++++++++
 2 files changed, 23 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..44a73ac
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,4 @@
+# [1.0.0] - 2023-11-17
+
+## Added
+- Initial project release with basic configuration.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e4b8bd8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Common PHPStan configuration for WP Desk
+
+This meta-package contains PHPStan configuration for WP Desk projects. This includes dependent extensions like `szepeviktor/phpstan-wordpress`, and additional, default configuration like inclusion of WooCommerce stubs.
+
+## Installation
+
+```sh
+composer require wpdesk/phpstan-rules
+```
+
+## Usage
+
+After installation, you can simply use PHPStan in your project without the need to further configuration. Nevertheless, as project grows, it's worth to add even [the basic one](https://phpstan.org/config-reference).
+
+To run PHPStan, simply execute the following command (<path> is only required if not present in configuration file):
+
+```sh
+vendor/bin/phpstan analyse <path>
+```
-- 
GitLab