diff --git a/.gitattributes b/.gitattributes index d641a25..744a43b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -9,10 +9,14 @@ /.editorconfig export-ignore /.gitattributes export-ignore /.gitignore export-ignore +/phpunit.xml export-ignore /phpunit.xml.dist export-ignore +/phpstan.neon export-ignore /phpstan.neon.dist export-ignore +/phpcs.xml export-ignore /phpcs.xml.dist export-ignore /infection.json export-ignore +/infection.json.dist export-ignore /Makefile export-ignore /CONTRIBUTING.md export-ignore /CHANGES.md export-ignore diff --git a/README.md b/README.md index 9af874a..60b4149 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,9 @@ ## Overview -Provides structured logging with support for correlation tracking and configurable sensitive data redaction. - -Built on top of [PSR-3](https://www.php-fig.org/psr/psr-3), the library can be used anywhere a `LoggerInterface` is -expected. +Emits PSR-3 structured logs for PHP, with each entry carrying timestamp, component, correlation id, level, and a +structured data payload. Supports pluggable redactions for sensitive fields such as passwords, emails, phone numbers, +and identity documents. Built for consumption by log aggregators and SIEM pipelines in production environments.
@@ -342,4 +341,4 @@ Logger is licensed under [MIT](LICENSE). ## Contributing Please follow the [contributing guidelines](https://github.com/tiny-blocks/tiny-blocks/blob/main/CONTRIBUTING.md) to -contribute to the project. \ No newline at end of file +contribute to the project. diff --git a/composer.json b/composer.json index ad8e733..8fc9415 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "tiny-blocks/logger", - "description": "Provides structured logging with support for correlation tracking and configurable sensitive data redaction.", + "description": "Emits PSR-3 structured logs for PHP, with correlation tracking and configurable sensitive data redaction.", "license": "MIT", "type": "library", "authors": [