From 1897718a4023ea08cbccb3e11ad657d102650f64 Mon Sep 17 00:00:00 2001
From: Kenneth Sills <132029135+Kenneth-Sills@users.noreply.github.com>
Date: Tue, 6 Aug 2024 08:06:16 +0000
Subject: [PATCH] docs: add a clear note that we do not strictly follow PSR/PER

Closes #2288
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index b15bf1450..7a220495d 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,10 @@ Prettier is an opinionated code formatter. It enforces a consistent style by par
 
 This plugin adds support for the PHP language to Prettier.
 
+> [!NOTE]
+>
+> This plugin has always used PSR / PER as guidance when making formatting decisions, but has never aimed to be fully PSR / PER compliant. The idea behind this plugin is to stay reasonably close to how Prettier for JS works.
+
 ### Can this be used in production?
 
 We're considering the plugin to be stable when pure PHP files are formatted. Formatting of files that contain mixed PHP and HTML is still considered unstable - please see [open issues with the tag "inline"](/~https://github.com/prettier/plugin-php/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Ainline) for details.