updated documentation

.github/workflows/docs-build.yml

@@ -0,0 +1,16 @@
+name: docs-build
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Docs
+        uses: dotkernel/documentation-theme/github-actions/docs@main
+        env:
+          DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

SECURITY.md

@@ -0,0 +1,40 @@
+# Security Policy
+
+## Supported Versions
+
+
+| Version | Supported          | PHP Version                                                                                        |
+|---------|--------------------|----------------------------------------------------------------------------------------------------|
+| 4.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/3.4.7) |
+| <= 3.x  | :x:                |                                                                                                    |
+
+
+## Reporting Potential Security Issues
+
+If you have encountered a potential security vulnerability in this project,
+please report it to us at <[email protected]>. We will work with you to
+verify the vulnerability and patch it.
+
+When reporting issues, please provide the following information:
+
+- Component(s) affected
+- A description indicating how to reproduce the issue
+- A summary of the security vulnerability and impact
+
+We request that you contact us via the email address above and give the
+project contributors a chance to resolve the vulnerability and issue a new
+release prior to any public exposure; this helps protect the project's
+users, and provides them with a chance to upgrade and/or update in order to
+protect their applications.
+
+
+## Policy
+
+If we verify a reported security vulnerability, our policy is:
+
+- We will patch the current release branch, as well as the immediate prior minor
+  release branch.
+
+- After patching the release branches, we will immediately issue new security
+  fix releases for each patched release branch.
+

docs/book/v4/usage.md

@@ -0,0 +1,22 @@
+## Usage
+Basic usage of the logger is illustraded below.
+
+The messages are written to see which logs are written and which are not written.
+```php
+use Laminas\Log\Logger;
+```
+...
+```php
+$logger = $container->get('dot-log.my_logger');
+
+/** @var Logger $logger */
+$logger->emerg('0 EMERG');
+$logger->alert('1 ALERT');
+$logger->crit('2 CRITICAL');
+$logger->err('3 ERR');
+$logger->warn('4 WARN');
+$logger->notice('5 NOTICE');
+$logger->info('6 INF');
+$logger->debug('7 debug');
+$logger->log(Logger::NOTICE, 'NOTICE from log()');
+```

mkdocs.yml

@@ -0,0 +1,21 @@
+docs_dir: docs/book
+site_dir: docs/html
+extra:
+  project: Packages
+  current_version: v4
+  versions:
+    - v4
+nav:
+  - Home: index.md
+  - v4:
+      - "Adding The Config Provider": v4/addingConfigProvider.md
+      - "Configuring the writer(s)": v4/configuringWriter.md
+      - "Grouping log files by date": v4/groupingLogFilesByDate.md
+      - "Filtering log messages": v4/filteringLogMessages.md
+      - "Formatting Messages": v4/formattingMessages.md
+      - "Usage": v4/usage.md
+site_name: dot-log
+site_description: "DotKernel log component extending and customizing"
+repo_url: "https://github.com/dotkernel/dot-log"
+plugins:
+  - search