From 4054f62e4414c39ff44d4527a54a5b5e6dbcbd6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?c=C4=83t=C4=83lin?= Date: Mon, 2 Oct 2023 22:57:20 +0200 Subject: [PATCH] feat: update README, add install section --- README.md | 7 ++++++- shush/supress.py | 1 - 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb5c445..707d37c 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,12 @@ Async-compatible, dependency-less, simple log suppression and filtering lib +## Install + +```shell +pip install shushlog +``` + ## TLDR - supress all logs @@ -21,7 +27,6 @@ Async-compatible, dependency-less, simple log suppression and filtering lib >>> @shush.suppress >>> def suppressed_func(): >>> logger.info("this should not be logged") ->>> @shush.suppress >>> def normal_func(): >>> logger.info("this should be logged") >>> suppressed_func() diff --git a/shush/supress.py b/shush/supress.py index 35f9d2d..c2db6b0 100644 --- a/shush/supress.py +++ b/shush/supress.py @@ -15,7 +15,6 @@ def suppress(func): >>> @shush.suppress >>> def suppressed_func(): >>> logger.info("this should not be logged") - >>> @shush.suppress >>> def normal_func(): >>> logger.info("this should be logged") >>> suppressed_func()