Skip to content

Commit 1a009ee

Browse files
committed
docs: update readme file (#15)
closes #7
1 parent 9d08ded commit 1a009ee

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,21 @@ An opinionated and re-usable Prettier config file created by Jeff Mosawy
66
[![version](https://img.shields.io/github/package-json/v/jmosawy/prettier-config)](https://github.com/jmosawy/prettier-config/)
77
[![outdated](https://img.shields.io/librariesio/release/npm/@jmosawy/prettier-config)](https://github.com/jmosawy/prettier-config/)
88
[![publish](https://github.com/jmosawy/prettier-config/actions/workflows/publish.yml/badge.svg)](https://github.com/jmosawy/)
9+
10+
## Installation and usage
11+
12+
> You most probably are familiar with Prettier, but in case you're not, visit their [website](https://prettier.io/) to learn more.
13+
14+
To install this package, copy the following command into the terminal:
15+
16+
```bash
17+
npm i @jmosawy/prettier-config -D
18+
```
19+
20+
Then, create a prettier config file in your project's root, e.g. `.prettierrc`, and paste the following code:
21+
22+
```
23+
"@jmosawy/prettier-config"
24+
```
25+
26+
If you want to overwrite a config, please follow the instructions [here](https://prettier.io/docs/en/configuration.html#sharing-configurations).

0 commit comments

Comments
 (0)