Skip to content

Commit f3c7c40

Browse files
committed
Update readme, editorconfig, phpcs ruleset
1 parent 12c4b71 commit f3c7c40

File tree

4 files changed

+11
-26
lines changed

4 files changed

+11
-26
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ indent_style = space
1010
insert_final_newline = true
1111
trim_trailing_whitespace = true
1212

13-
[{*.yml,package.json}]
13+
[{*.yml,*.scss,*.js,package.json}]
1414
indent_size = 2
1515

1616
# The indent size used in the package.json file cannot be changed:

.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
/.gitignore export-ignore
55
/.travis.yml export-ignore
66
/.scrutinizer.yml export-ignore
7+
/codecov.yml export-ignore

README.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,6 @@
22
[![Build Status](https://travis-ci.org/silverstripe/silverstripe-blog.svg?branch=master)](https://travis-ci.org/silverstripe/silverstripe-blog)
33
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-blog/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-blog/?branch=master)
44
[![codecov.io](https://codecov.io/github/silverstripe/silverstripe-blog/coverage.svg?branch=master)](https://codecov.io/github/silverstripe/silverstripe-blog?branch=master)
5-
![helpfulrobot](https://helpfulrobot.io/silverstripe/blog/badge)
6-
7-
[![Latest Stable Version](https://poser.pugx.org/silverstripe/blog/version)](https://packagist.org/packages/silverstripe/blog)
8-
[![License](https://poser.pugx.org/silverstripe/blog/license)](https://packagist.org/packages/silverstripe/blog)
9-
[![Monthly Downloads](https://poser.pugx.org/silverstripe/blog/d/monthly)](https://packagist.org/packages/silverstripe/blog)
10-
115

126
## Documentation
137

@@ -16,18 +10,18 @@
1610

1711
## Requirements
1812

19-
```
20-
silverstripe/cms: ^4.0
21-
silverstripe/lumberjack: ^2.0
22-
silverstripe/tagfield: ^2.0
23-
```
13+
* SilverStripe CMS 4.0+
14+
* SilverStripe Lumberjack Module 2.0+
15+
* SilverStripe Tag Field Module 2.0+
16+
* SilverStripe Assets 1.0+
17+
* SilverStripe Asset Admin Module 1.0+
18+
19+
Note: this version is compatible with SilverStripe 4. For SilverStripe 3, please see [the 2.x release line](https://github.com/silverstripe/silverstripe-blog/tree/2).
2420

2521
### Suggested Modules
2622

27-
```
28-
silverstripe/widgets: *
29-
silverstripe/comments: *
30-
```
23+
* SilverStripe Widgets Module
24+
* SilverStripe Comments Module
3125

3226
## Installation
3327

phpcs.xml.dist

-10
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,6 @@
77
<!-- Current exclusions -->
88
<exclude name="PSR1.Methods.CamelCapsMethodName" />
99
<exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
10-
<exclude name="PSR2.Classes.PropertyDeclaration" />
11-
<exclude name="PSR2.ControlStructures.SwitchDeclaration" /> <!-- causes php notice while linting -->
12-
<exclude name="PSR2.ControlStructures.SwitchDeclaration.WrongOpenercase" />
13-
<exclude name="PSR2.ControlStructures.SwitchDeclaration.WrongOpenerdefault" />
14-
<exclude name="PSR2.ControlStructures.SwitchDeclaration.TerminatingComment" />
15-
<exclude name="PSR2.Methods.MethodDeclaration.Underscore" />
16-
<exclude name="Squiz.Scope.MethodScope" />
17-
<exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
18-
<exclude name="Generic.Files.LineLength.TooLong" />
19-
<exclude name="PEAR.Functions.ValidDefaultValue.NotAtEnd" />
2010
</rule>
2111
</ruleset>
2212

0 commit comments

Comments
 (0)