From e46b8bcd0f8fbd8fec5559f2d6705236f169e135 Mon Sep 17 00:00:00 2001
From: Daniel Seifert <git@daniel-seifert.com>
Date: Thu, 6 Feb 2025 13:08:51 +0100
Subject: [PATCH] add documentation

---
 .php-cs-fixer.php | 34 ++++++++++++++++++++++++++++++++++
 CHANGELOG.md      | 13 +++++++++++++
 LICENSE.md        | 21 +++++++++++++++++++++
 phpstan.neon      |  7 +++++++
 4 files changed, 75 insertions(+)
 create mode 100644 .php-cs-fixer.php
 create mode 100644 CHANGELOG.md
 create mode 100644 LICENSE.md
 create mode 100644 phpstan.neon

diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
new file mode 100644
index 0000000..9c1c04b
--- /dev/null
+++ b/.php-cs-fixer.php
@@ -0,0 +1,34 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+;
+
+$header = <<<EOF
+Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
+
+For the full copyright and license information, please view
+the LICENSE file that was distributed with this source code.
+
+https://www.d3data.de
+
+@copyright (C) D3 Data Development (Inh. Thomas Dartsch)
+@author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+@link      https://www.oxidmodule.com
+EOF;
+
+$config = new PhpCsFixer\Config();
+return $config->setRules([
+    '@PHP80Migration' => true,
+    '@PSR12' => true,
+    'header_comment' => [
+        'comment_type' => 'PHPDoc',
+        'header' => $header,
+        'location' => 'after_open',
+        'separate' => 'both',
+    ],
+    'php_unit_test_class_requires_covers' => true,
+    'doctrine_annotation_indentation' => true,
+])
+    ->setFinder($finder)
+;
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..5dbf009
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://git.d3data.de/D3Public/loggerFactory/compare/1.0.0...rel_1.x)
+
+## [1.0.0](https://git.d3data.de/D3Public/loggerFactory/releases/tag/1.0.0) - 2025-02-06
+### Added
+- initial implementation
+    - can create a custom Logger instance rotating or static
+    - combined logger (OXID and configured stream)
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..6fc6f3a
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D3 Data Development (Inh. Thomas Dartsch)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/phpstan.neon b/phpstan.neon
new file mode 100644
index 0000000..7920047
--- /dev/null
+++ b/phpstan.neon
@@ -0,0 +1,7 @@
+parameters:
+  bootstrapFiles:
+    - tests\Helpers\classAliases.php
+  paths:
+    - src
+  level: 10
+  phpVersion: 80000
\ No newline at end of file