Skip to content

Commit d2699ef

Browse files
authored
moar-readme (#72)
* add build status, update links, add how to contrib * add codecov badge
1 parent 7e89009 commit d2699ef

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# prettier-plugin-solidity
22

3-
work in progress [prettier plugin](https://github.com/prettier/prettier/issues/4180) for [solidity](https://github.com/ethereum/solidity)
3+
[![Build Status](https://travis-ci.com/prettier-solidity/prettier-plugin-solidity.svg?branch=master)](https://travis-ci.com/prettier-solidity/prettier-plugin-solidity)
4+
[![codecov](https://codecov.io/gh/prettier-solidity/prettier-plugin-solidity/branch/master/graph/badge.svg)](https://codecov.io/gh/prettier-solidity/prettier-plugin-solidity)
5+
6+
This is a work in progress [Prettier Plugin](https://prettier.io/docs/en/plugins.html) for [Solidity](https://github.com/ethereum/solidity).
47

58
## Installation and usage
69

@@ -21,3 +24,15 @@ Or you can use it as part of your linting to check that all your code is prettif
2124
```
2225
"lint": "prettier --list-different **/*.sol"
2326
```
27+
28+
## Contributing
29+
30+
1. [Fork it](https://github.com/prettier-solidity/prettier-plugin-solidity/fork)
31+
2. Create your feature branch (`git checkout -b feature/fooBar`)
32+
3. Commit your changes (`git commit -am 'Add some fooBar'`)
33+
4. Push to the branch (`git push origin feature/fooBar`)
34+
5. Create a new Pull Request
35+
36+
## License
37+
38+
Distributed under the MIT license. See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)