Skip to content

Commit cadfcdb

Browse files
committed
Update readme
1 parent 1e81465 commit cadfcdb

File tree

3 files changed

+101
-2
lines changed

3 files changed

+101
-2
lines changed

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
9+
## [Unreleased](https://github.com/inspirum/coding-standard-php/compare/v1.1.1...master)
10+
11+
12+
## [v1.1.1 (2022-07-04)](https://github.com/inspirum/coding-standard-php/compare/v1.1.0...v1.1.1)
13+
### Removed
14+
- Exclude `RequireOneLineDocComment` rule
15+
16+
17+
## [v1.1.0 (2022-07-04)](https://github.com/inspirum/coding-standard-php/compare/v1.0.1...v1.1.0)
18+
### Changed
19+
- Better support for PHP 8.1 (Update slevomat/coding-standard to ^8.0)
20+
21+
22+
## [v1.0.1 (2022-06-07)](https://github.com/inspirum/coding-standard-php/compare/v1.0.0...v1.0.1)
23+
### Added
24+
- Support PHP `^7.4`
25+
26+
27+
## v1.0.0 (2022-05-20)
28+
### Added
29+
- Added `InspirumCodingStandard` PHPCS standard

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2020 Tomáš Novotný <tomas.novotny@inspirum.cz>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,60 @@
11
# Coding standard
22

3-
* Run `composer require --dev inspirum/coding-standard`
4-
* Create `phpcs.xml.dist` file with:
3+
**Created as part of [inspishop][link-inspishop] e-commerce platform by [inspirum][link-inspirum] team.**
4+
5+
[![Latest Stable Version][ico-packagist-stable]][link-packagist-stable]
6+
[![Total Downloads][ico-packagist-download]][link-packagist-download]
7+
[![Software License][ico-license]][link-licence]
8+
9+
10+
## System requirements
11+
12+
* [PHP 7.4+](http://php.net/releases/7_4_0.php), [PHP 8.0+](http://php.net/releases/8_0_0.php)
13+
14+
15+
## Installation
16+
17+
Run composer require command:
18+
```
19+
composer require --dev inspirum/coding-standard
20+
```
21+
22+
Create `phpcs.xml.dist` file with:
523

624
```xml
725
<?xml version="1.0" encoding="UTF-8"?>
826
<ruleset>
927
<rule ref="InspirumCodingStandard"/>
1028
</ruleset>
1129
```
30+
31+
32+
## Security
33+
34+
If you discover any security related issues, please email tomas.novotny@inspirum.cz instead of using the issue tracker.
35+
36+
37+
## Credits
38+
39+
- [Tomáš Novotný](https://github.com/tomas-novotny)
40+
- [All Contributors][link-contributors]
41+
42+
43+
## License
44+
45+
The MIT License (MIT). Please see [License File][link-licence] for more information.
46+
47+
48+
[ico-license]: https://img.shields.io/github/license/inspirum/coding-standard-php.svg?style=flat-square&colorB=blue
49+
[ico-workflow]: https://img.shields.io/github/workflow/status/inspirum/coding-standard-php/Test/master?style=flat-square
50+
[ico-packagist-stable]: https://img.shields.io/packagist/v/inspirum/coding-standard.svg?style=flat-square&colorB=blue
51+
[ico-packagist-download]: https://img.shields.io/packagist/dt/inspirum/coding-standard.svg?style=flat-square&colorB=blue
52+
53+
[link-author]: https://github.com/inspirum
54+
[link-contributors]: https://github.com/inspirum/coding-standard-php/contributors
55+
[link-licence]: ./LICENSE.md
56+
[link-changelog]: ./CHANGELOG.md
57+
[link-inspishop]: https://www.inspishop.cz/
58+
[link-inspirum]: https://www.inspirum.cz/
59+
[link-packagist-stable]: https://packagist.org/packages/inspirum/coding-standard
60+
[link-packagist-download]: https://packagist.org/packages/inspirum/coding-standard

0 commit comments

Comments
 (0)