Merge pull request #74 from Jurj-Bogdan/4.1-documentation

issues 70, 71, 72 for branch 4.1
dotkernel · Feb 14, 2025 · 94d06cf · 94d06cf
2 parents 4c46146 + 842634b
commit 94d06cf
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,15 @@
 # dot-log
 
+Robust, composite logger with filtering and formatting.
+
+## Documentation
+
+Documentation is available at: https://docs.dotkernel.org/dot-log/v4/overview/.
+
+## Badges
+
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-log)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/4.1.1)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/4.1.2)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-log)](https://github.com/dotkernel/dot-log/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-log)](https://github.com/dotkernel/dot-log/network)
@@ -255,5 +263,3 @@ $logger->info('6 INF');
 $logger->debug('7 debug');
 $logger->log(Logger::NOTICE, 'NOTICE from log()');
 ```
-
-Extracted from [this article](https://www.dotkernel.com/dotkernel/logging-with-dot-log-in-mezzio-and-dotkernel)
diff --git a/SECURITY.md b/SECURITY.md
@@ -3,10 +3,12 @@
 ## Supported Versions
 
 
-| Version | Supported          | PHP Version                                                                                        |
-|---------|--------------------|----------------------------------------------------------------------------------------------------|
+| Version | Supported          | PHP Version                                                                                             |
+|---------|--------------------|---------------------------------------------------------------------------------------------------------|
+| 5.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/5.0.0) |
+| 4.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/4.1.1) |
 | 3.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/3.4.7) |
-| <= 2.x  | :x:                |                                                                                                    |
+| <= 2.x  | :x:                |                                                                                                         |
 
 
 ## Reporting Potential Security Issues

diff --git a/composer.json b/composer.json
@@ -1,16 +1,14 @@
 {
     "name": "dotkernel/dot-log",
     "type": "library",
-    "description": "Dotkernel log component extending and customizing laminas-log",
+    "description": "Dotkernel log component",
     "license": "MIT",
     "homepage": "https://github.com/dotkernel/dot-log",
     "keywords": [
       "log",
       "logging",
       "services",
-      "mezzio",
-      "laminas",
-      "laminas-log"
+      "laminas"
     ],
     "authors": [
         {

diff --git a/docs/book/v4/overview.md b/docs/book/v4/overview.md
@@ -1,5 +1,3 @@
 # Overview
 
-Robust, composite logger with filtering, formatting, and PSR-3 support.
-
-> dot-log is a wrapper on top of [laminas-log](https://github.com/laminas/laminas-log)
+Robust, composite logger with filtering and formatting.