docs: add README file 📝

2022-08-26 15:36:50 +01:00 · 2022-08-26 15:36:50 +01:00 · f72e794a8b
commit f72e794a8b
parent 546953fcbb
1 changed files with 23 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,23 @@
+# @walidoux/prettier-config
+
+⚙️ Walidoux's Prettier config.
+
+[![npm](https://img.shields.io/npm/v/@walidoux/prettier-config?color=%230cf)](https://www.npmjs.com/package/@walidoux/prettier-config)[![license](https://img.shields.io/github/license/walidoux/prettier-config?color=%2385f)](https://github.com/walidoux/prettier-config/blob/main/LICENSE)
+
+## Installation
+
+```bash
+YARN ➜  yarn add -D prettier @walidoux/prettier-config
+
+NPM  ➜  npm install --save-dev prettier @walidoux/prettier-config
+```
+
+## Usage
+
+Add it to your project inside `package.json`'s file.
+
+```json
+{
+  "prettier": "@marcbouchenoire/prettier-config"
+}
+```