diff --git a/README.md b/README.md index be1ad6759..90752cd81 100644 --- a/README.md +++ b/README.md @@ -68,19 +68,21 @@ The library also provides a versatile [AudioPlayer](https://pschatzmann.github.i ### Logging -The application uses a built in logger (see AudioLogger.h and AudioConfig.h). You can deactivate the logging by changing USE_AUDIO_LOGGING to false in the AudioConfig.h to decrease the memory usage: +The application uses a built in logger: By default we use the log level warning and the logging output is going to Serial. You can change this in your sketch by calling e.g: ```C++ -#define USE_AUDIO_LOGGING false +AudioToolsLogger.begin(Serial, AudioToolsLogLevel::Debug); ``` -Per default we use the log level warning and the logging output is going to Serial. You can change this in your sketch by calling AudioLogger begin with the output stream and the log level e.g: +Valid values are: Debug, Info, Warning, Error. + + +You can also deactivate the logging by changing USE_AUDIO_LOGGING to false in the AudioConfig.h to decrease the memory usage: ```C++ -AudioToolsLogger.begin(Serial, AudioToolsLogLevel::Debug); +#define USE_AUDIO_LOGGING false ``` - ## Show and Tell Get some inspiration [from projects that were using this library](https://github.com/pschatzmann/arduino-audio-tools/discussions/categories/show-and-tell) or share your projects with the community.