From adb86792580605333fa07f94628844082140f44d Mon Sep 17 00:00:00 2001 From: Harminder Virk Date: Thu, 10 Nov 2022 10:15:12 +0530 Subject: [PATCH] docs(README): update --- README.md | 42 +++++++++++++++--------------------------- 1 file changed, 15 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 23c1545..dcfe80f 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,29 @@ -
- -
+# @adonisjs/logger
-

AdonisJS Logger

-

AdonisJS logger built on top of pino for speed and minimal runtime overhead.

+ +[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url] +
-
+## Introduction +AdonisJS Logger is built on top of [Pino](https://getpino.io/#/). Additionally, we have added support to create multiple named loggers, and make it easy to type-hint Logger as a container dependency. -
+## Official Documentation +The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/logger) -[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url] +## Contributing +One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework. -
+We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework. -
-

- - Website - - | - - Guides - - | - - Contributing - -

-
+## Code of Conduct +In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md). -
- Built with ❤︎ by Harminder Virk -
+## License +AdonisJS logger is open-sourced software licensed under the [MIT license](LICENSE.md). [gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/logger/test?style=for-the-badge [gh-workflow-url]: https://github.com/adonisjs/logger/actions/workflows/test.yml "Github action"