usage docs

ionic-team · Jul 13, 2020 · 0ff44b6 · 0ff44b6
1 parent 6004807
commit 0ff44b6
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,20 @@
 # @ionic/prettier-config
 
 Shared Prettier config used in Ionic and Capacitor projects.
+
+## Usage
+
+Usage is based on [Sharing configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations) from the Prettier docs.
+
+1. Remove existing `.prettierrc` file, if present.
+1. Install the config.
+
+    ```
+    npm install -D @ionic/prettier-config
+    ```
+
+1. Add the following to `package.json`:
+
+    ```
+    "prettier": "@ionic/prettier-config",
+    ```