From 90b741593c3ecda11d80acf2ec4cd63d91b7f5fb Mon Sep 17 00:00:00 2001
From: Matthias Hecht <matthias.hecht@boehringer-ingelheim.com>
Date: Mon, 13 May 2024 13:59:33 +0200
Subject: [PATCH] docs: update readme to include single quote decision

---
 README.md | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 7f950df..a6062fb 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Prettier Configuration
 
-> Prettier is an opinionated code formatter and removes all original styling and ensures that all outputted code conforms to a consistent code style across your entire codebase. - https://prettier.io/docs/en/index.html
+> Prettier is an opinionated code formatter and removes all original styling and ensures that all outputted code conforms to a consistent code style across your entire codebase. - <https://prettier.io/docs/en/index.html>
 
 This is the shared prettier configuration used at [Boehringer Ingelheim](https://github.com/orgs/Boehringer-Ingelheim) for code formatting.
 
@@ -56,6 +56,16 @@ Specify the line length that the printer will wrap on.
 printWidth: 120;
 ```
 
+### Single Quotes
+
+Use single quotes instead of double quotes. (This only applies if there are the same number of single quotes as double quotes in the string. See the [strings rationale in the prettier docs](https://prettier.io/docs/en/rationale#strings) for more information)
+
+*We have chosen single quotes over double quotes, as it is the most common option for JS/TS (open-source) projects. Reference: <https://bytearcher.com/articles/single-or-double-quotes-strings-javascript/>*
+
+```js
+singleQuote: true;
+```
+
 ## Local Development
 
 ### Install Dependencies
@@ -104,12 +114,12 @@ Give a ⭐️ if this project helped you!
 
 ## License
 
-Copyright © 2024 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).<br />
+Copyright © 2024 [Boehringer Ingelheim](https://github.com/boehringer-ingelheim).\
 This project is [MIT](https://github.com/boehringer-ingelheim/prettier-config/blob/master/LICENSE) licensed.
 
 ## Resources
 
-- https://prettier.io/
-- https://conventionalcommits.org/en/v1.0.0/
-- https://semantic-release.gitbook.io/
-- https://semver.org/
+- <https://prettier.io/>
+- <https://conventionalcommits.org/en/v1.0.0/>
+- <https://semantic-release.gitbook.io/>
+- <https://semver.org/>