Skip to content

Commit 94bfb43

Browse files
authored
Readme: polished (#25)
1 parent 3c5b41f commit 94bfb43

File tree

1 file changed

+43
-12
lines changed

1 file changed

+43
-12
lines changed

README.md

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,39 @@
1-
# Coding standard
1+
![](https://heatbadger.now.sh/github/readme/ninjify/coding-standard/)
22

3-
Tuned & very strict coding standards for PHP projects. Trusted by [Contributte](https://github.com/contributte), [Apitte](https://github.com/apitte), [Nettrine](https://github.com/nettrine)
4-
and many others projects.
3+
<p align=center>
4+
<a href="https://packagist.org/packages/ninjify/coding-standard"><img src="https://badgen.net/packagist/dm/ninjify/coding-standard"></a>
5+
<a href="https://packagist.org/packages/ninjify/coding-standard"><img src="https://badgen.net/packagist/v/ninjify/coding-standard"></a>
6+
</p>
7+
<p align=center>
8+
<a href="https://packagist.org/packages/ninjify/coding-standard"><img src="https://badgen.net/packagist/php/ninjify/coding-standard"></a>
9+
<a href="https://github.com/ninjify/coding-standard"><img src="https://badgen.net/github/license/ninjify/coding-standard"></a>
10+
<a href="https://bit.ly/ctteg"><img src="https://badgen.net/badge/support/gitter/cyan"></a>
11+
<a href="https://bit.ly/cttfo"><img src="https://badgen.net/badge/support/forum/yellow"></a>
12+
<a href="https://contributte.org/partners.html"><img src="https://badgen.net/badge/sponsor/donations/F96854"></a>
13+
</p>
514

6-
This library use sniffs from [slevomat/coding-standard](https://github.com/slevomat/coding-standard) and ruleset definitions are based on [consistence/coding-standard](https://github.com/consistence/coding-standard) and [doctrine/coding-standard](https://github.com/doctrine/coding-standard). Thank yu guys.
15+
<p align=center>
16+
Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact 👨🏻‍💻 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 🐦 <a href="https://twitter.com/contributte">@contributte</a>
17+
</p>
718

8-
-----
9-
10-
[![Downloads total](https://img.shields.io/packagist/dt/ninjify/coding-standard.svg?style=flat-square)](https://packagist.org/packages/ninjify/coding-standard)
11-
[![Latest stable](https://img.shields.io/packagist/v/ninjify/coding-standard.svg?style=flat-square)](https://packagist.org/packages/ninjify/coding-standard)
19+
## Usage
1220

13-
## Install
21+
To install latest version of `ninjify/coding-standard` use [Composer](https://getcomposer.com).
1422

15-
```bash
23+
```
1624
composer require --dev ninjify/coding-standard
1725
```
1826

19-
## Usage
27+
## Versions
28+
29+
| State | Version | Branch | PHP |
30+
|-------------|--------------|----------|----------|
31+
| dev | `^0.12` | `master` | `>= 7.2` |
32+
| stable | `^0.11` | `master` | `>= 7.2` |
33+
34+
## Documentation
35+
36+
### Usage
2037

2138
| File | Usage |
2239
|---------------|--------|
@@ -41,6 +58,20 @@ Create `ruleset.xml` in root of your project.
4158
</ruleset>
4259
```
4360

44-
## Integration
61+
### Integration
4562

4663
Take a look at `phpstorm` folder, there should be prepared codestyle.
64+
65+
66+
## Development
67+
68+
See [how to contribute](https://contributte.org) to this package. This package is currently maintained by these authors.
69+
70+
<a href="https://github.com/f3l1x">
71+
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
72+
</a>
73+
74+
-----
75+
76+
Consider to [support](https://contributte.org/partners.html) **contributte** development team.
77+
Also thank you for using this package.

0 commit comments

Comments
 (0)