From 3faf968a6941cb34a3904c03125e5bf9be3cce12 Mon Sep 17 00:00:00 2001 From: Petr Parolek Date: Sun, 9 May 2021 22:33:30 +0200 Subject: [PATCH] polished ReadMe --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 43 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ec6f3c0..68e58df 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,39 @@ -# Coding standard +![](https://heatbadger.now.sh/github/readme/ninjify/coding-standard/) -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) -and many others projects. +

+ + +

+

+ + + + + +

-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. +

+Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte +

------ - -[![Downloads total](https://img.shields.io/packagist/dt/ninjify/coding-standard.svg?style=flat-square)](https://packagist.org/packages/ninjify/coding-standard) -[![Latest stable](https://img.shields.io/packagist/v/ninjify/coding-standard.svg?style=flat-square)](https://packagist.org/packages/ninjify/coding-standard) +## Usage -## Install +To install latest version of `ninjify/coding-standard` use [Composer](https://getcomposer.com). -```bash +``` composer require --dev ninjify/coding-standard ``` -## Usage +## Versions + +| State | Version | Branch | PHP | +|-------------|--------------|----------|----------| +| dev | `^0.12` | `master` | `>= 7.2` | +| stable | `^0.11` | `master` | `>= 7.2` | + +## Documentation + +### Usage | File | Usage | |---------------|--------| @@ -41,6 +58,20 @@ Create `ruleset.xml` in root of your project. ``` -## Integration +### Integration Take a look at `phpstorm` folder, there should be prepared codestyle. + + +## Development + +See [how to contribute](https://contributte.org) to this package. This package is currently maintained by these authors. + + + + + +----- + +Consider to [support](https://contributte.org/partners.html) **contributte** development team. +Also thank you for using this package.