Skip to content

Commit 72ee887

Browse files
authored
Create README.md
1 parent ee6c917 commit 72ee887

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# prettier-config
2+
Prettier config used at GitHub
3+
4+
## Usage
5+
6+
Install the package using `npm` (or `yarn`)
7+
8+
```sh
9+
npm install --save-dev @github/prettier-config
10+
```
11+
12+
Add the `prettier` key to your `package.json`
13+
14+
```diff
15+
diff --git a/package.json b/package.json
16+
index 2ecef3d..260838f 100644
17+
--- a/package.json
18+
+++ b/package.json
19+
@@ -5,6 +5,7 @@
20+
"keywords": [
21+
"prettier"
22+
],
23+
+ "prettier": "@github/prettier-config",
24+
"license": "MIT",
25+
"author": "GitHub Inc.",
26+
"main": "index.js"
27+
```
28+
29+
[Check out the `prettier` documentation for more info on sharing configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations).

0 commit comments

Comments
 (0)