Skip to content

Commit c17049d

Browse files
committed
docs(readme): add centered logo and badge header #0
Logo assets are export-ignored from the Composer dist, so the README references them via absolute raw.githubusercontent URLs to keep the header rendering on Packagist.
1 parent 079391e commit c17049d

6 files changed

Lines changed: 26 additions & 8 deletions

File tree

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
/.editorconfig export-ignore
44
/.gitattributes export-ignore
55
/.gitignore export-ignore
6+
7+
/art export-ignore
68
/tests export-ignore
9+
710
/phpcs.xml export-ignore
811
/phpunit.xml export-ignore
912
/phpunit.xml.dist export-ignore

‎README.md‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1-
# IxDF PHP Coding Standard
2-
3-
[![Tests](https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/test.yml/badge.svg)](https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/test.yml)
4-
[![PHP Psalm](https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/psalm.yml/badge.svg)](https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/psalm.yml)
5-
[![PHP Psalm Level](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard/level.svg)](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard)
6-
[![PHP Psalm Type Coverage](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard/coverage.svg)](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard)
7-
8-
An opinionated coding standard for PHP and Laravel projects, built on [PER-CS 3](https://www.php-fig.org/per/coding-style/).
1+
<p align="center">
2+
<a href="https://www.interaction-design.org" target="_blank">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/InteractionDesignFoundation/coding-standard/main/art/logo_gdt_dark.svg">
5+
<img src="https://raw.githubusercontent.com/InteractionDesignFoundation/coding-standard/main/art/logo_gdt_light.svg" alt="IxDF PHP Coding Standard" width="200">
6+
</picture>
7+
</a>
8+
</p>
9+
10+
<p align="center">
11+
<a href="https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/test.yml"><img src="https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
12+
<a href="https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/psalm.yml"><img src="https://github.com/InteractionDesignFoundation/coding-standard/actions/workflows/psalm.yml/badge.svg" alt="PHP Psalm"></a>
13+
<a href="https://shepherd.dev/github/InteractionDesignFoundation/coding-standard"><img src="https://shepherd.dev/github/InteractionDesignFoundation/coding-standard/level.svg" alt="PHP Psalm Level"></a>
14+
<a href="https://shepherd.dev/github/InteractionDesignFoundation/coding-standard"><img src="https://shepherd.dev/github/InteractionDesignFoundation/coding-standard/coverage.svg" alt="PHP Psalm Type Coverage"></a>
15+
<a href="https://packagist.org/packages/interaction-design-foundation/coding-standard"><img src="https://img.shields.io/packagist/dt/interaction-design-foundation/coding-standard" alt="Total Downloads"></a>
16+
<a href="https://packagist.org/packages/interaction-design-foundation/coding-standard"><img src="https://img.shields.io/packagist/v/interaction-design-foundation/coding-standard" alt="Latest Stable Version"></a>
17+
</p>
18+
19+
## IxDF PHP Coding Standard
20+
21+
An opinionated coding standard for PHP and Laravel projects, built on [PER-CS3.0](https://www.php-fig.org/per/coding-style/).
922
Focuses on:
1023
- **High signal-to-noise ratio** (concise but informative PHPDoc, e.g. array shapes)
1124
- **Strict, explicit code**: `strict_types`, strict comparisons, final by default, no magic

‎art/logo_gdt_dark.png‎

98.1 KB
Loading

‎art/logo_gdt_dark.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎art/logo_gdt_light.png‎

99.4 KB
Loading

‎art/logo_gdt_light.svg‎

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)