Skip to content

Commit 1b0cd29

Browse files
authored
Update README.md (#394)
1 parent f7dbedf commit 1b0cd29

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@
33
[![Build Status](https://travis-ci.com/prettier-solidity/prettier-plugin-solidity.svg?branch=master)](https://travis-ci.com/prettier-solidity/prettier-plugin-solidity)
44
[![codecov](https://codecov.io/gh/prettier-solidity/prettier-plugin-solidity/branch/master/graph/badge.svg)](https://codecov.io/gh/prettier-solidity/prettier-plugin-solidity)
55
[![Telegram](/assets/telegram-badge.svg)](https://t.me/joinchat/Je2WJFCfKJ_mht1XdhBh6w)
6+
[![Twitter Follow](https://img.shields.io/twitter/follow/PrettierSol.svg?style=social)](https://twitter.com/PrettierSol)
67

7-
This is a work in progress [Prettier Plugin](https://prettier.io/docs/en/plugins.html) for [Solidity](https://github.com/ethereum/solidity).
8+
<p align="center">
9+
<img width="375" height="375" src="https://user-images.githubusercontent.com/1022054/59317198-f1149b80-8d15-11e9-9b0f-0c5e7d4b8b81.png">
10+
</p>
11+
12+
A [Prettier Plugin](https://prettier.io/docs/en/plugins.html) for automatically formatting your [Solidity](https://github.com/ethereum/solidity) code.
813

914
If you like this project, please consider contributing to our [Gitcoin grant](https://gitcoin.co/grants/1534/prettier-solidity)!
1015

@@ -16,16 +21,22 @@ Install both `prettier` and `prettier-plugin-solidity`:
1621
npm install --save-dev prettier prettier-plugin-solidity
1722
```
1823

24+
Run prettier in your contracts:
25+
26+
```
27+
npx prettier --write 'contracts/**/*.sol'
28+
```
29+
1930
You can add a script for running prettier on all your contracts:
2031

2132
```
22-
"prettier": "prettier --write **/*.sol"
33+
"prettier": "prettier --write 'contracts/**/*.sol'"
2334
```
2435

2536
Or you can use it as part of your linting to check that all your code is prettified:
2637

2738
```
28-
"lint": "prettier --list-different **/*.sol"
39+
"lint": "prettier --list-different 'contracts/**/*.sol'"
2940
```
3041

3142
## Integrations

0 commit comments

Comments
 (0)