docs(README): addedusage instructions

CostasAK · Feb 5, 2024 · 045803b · 045803b
1 parent fdccae6
commit 045803b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,17 @@
-# prettier-config
+# `@costasak/prettier-config`
+
 My shareable Prettier configuration
+
+## Usage
+
+### Install
+
+```bash
+pnpm add -D @costasak/prettier-config
+```
+
+### Edit `.prettierrc.json`
+
+```json
+"@costasak/prettier-config"
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@costasak/prettier-config",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "My shareable Prettier configuration",
   "main": "index.json",
   "repository": "[email protected]:CostasAK/prettier-config.git",