Skip to content

polished ReadMe #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f3l1x merged 1 commit into from
May 11, 2021
Merged

polished ReadMe #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 43 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
<p align=center>
<a href="https://packagist.org/packages/ninjify/coding-standard"><img src="https://badgen.net/packagist/dm/ninjify/coding-standard"></a>
<a href="https://packagist.org/packages/ninjify/coding-standard"><img src="https://badgen.net/packagist/v/ninjify/coding-standard"></a>
</p>
<p align=center>
<a href="https://packagist.org/packages/ninjify/coding-standard"><img src="https://badgen.net/packagist/php/ninjify/coding-standard"></a>
<a href="https://github.com/ninjify/coding-standard"><img src="https://badgen.net/github/license/ninjify/coding-standard"></a>
<a href="https://bit.ly/ctteg"><img src="https://badgen.net/badge/support/gitter/cyan"></a>
<a href="https://bit.ly/cttfo"><img src="https://badgen.net/badge/support/forum/yellow"></a>
<a href="https://contributte.org/partners.html"><img src="https://badgen.net/badge/sponsor/donations/F96854"></a>
</p>

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.
<p align=center>
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>
</p>

-----

[![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 |
|---------------|--------|
Expand All @@ -41,6 +58,20 @@ Create `ruleset.xml` in root of your project.
</ruleset>
```

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

<a href="https://github.com/f3l1x">
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
</a>

-----

Consider to [support](https://contributte.org/partners.html) **contributte** development team.
Also thank you for using this package.