Update documentation

.php-cs-fixer.dist.php

@@ -24,11 +24,15 @@ namespace PhpCsFixer;
 
 /**
  * Configuration for PHP-CS-Fixer.
+ *
  * @see https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/config.rst
  *
  * @return ConfigInterface
  */
-return (new Config())
+$config = new Config();
+$finder = new Finder();
+
+return $config
     ->setRiskyAllowed(true)
     ->setRules(['@PSR12' => true])
-    ->setFinder((new Finder())->in(__DIR__));
+    ->setFinder($finder->in([__DIR__ . '/src']));

README.md

@@ -1,10 +1,25 @@
 # PHP Basics
 
-This is a collection of generic [classes](https://www.php.net/manual/en/language.oop5.php) and useful [traits](https://www.php.net/manual/en/language.oop5.traits.php) for your PHP projects.
+***A collection of generic classes and useful traits for PHP projects.***
 
-[![PHPStan](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml)
+The package currently contains classes for [type-sensitive data structures](src/DataStructures/), [error and exception handlers](src/ErrorHandlers/), multiple [traits implementing standard interfaces](src/InterfaceTraits/), and more generic [traits for common use cases](src/Traits/). They share the same design principles like property and method naming schema, highest [Psalm](https://psalm.dev/) and [PHPStan](https://phpstan.org/) coding standards and full [PSR-12](https://www.php-fig.org/psr/psr-12/) compliance to make sure they can be combined and easily re-used in other projects.
+
+## Quick Start
+
+The intended and recommended way of re-using this package is via [Composer](https://getcomposer.org/). The following command will get you the latest version:
+
+    composer require opencultureconsulting/basics
+
+All available versions as well as further information about requirements and dependencies can be found on [Packagist](https://packagist.org/packages/opencultureconsulting/basics).
+
+## Full Documentation
+
+The full documentation is available on [GitHub Pages](https://opencultureconsulting.github.io/php-basics/) or alternatively in [doc/](doc/).
+
+## Quality Gates
+
+[![PHPCS](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpcs.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpcs.yml)
 [![PHPMD](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpmd.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpmd.yml)
 
-## Usage
-
-The most convenient way to use the PHP Basics classes and traits in your own project is `composer require opencultureconsulting/basics`
+[![PHPStan](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/phpstan.yml)
+[![Psalm](https://github.com/opencultureconsulting/php-basics/actions/workflows/psalm.yml/badge.svg)](https://github.com/opencultureconsulting/php-basics/actions/workflows/psalm.yml)

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "opencultureconsulting/basics",
-    "description": "This is a collection of generic Classes and useful Traits for PHP projects.",
+    "description": "A collection of generic classes and useful traits for PHP projects.",
     "type": "library",
     "keywords": [
         "ArrayAccess",

phpcs.xml.dist

@@ -3,5 +3,7 @@
     <description>Open Culture Consulting strictly follows PSR standards.</description>
     <file>./src</file>
     <arg name="extensions" value="php"/>
+    <rule ref="PSR1"/>
+    <rule ref="PSR2"/>
     <rule ref="PSR12"/>
 </ruleset>