Skip to content

[Docs]: Correct README.md to match initialize declaration with string argument #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nircoe merged 5 commits into from
Aug 10, 2025
Merged

[Docs]: Correct README.md to match initialize declaration with string argument #2

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c18a1a8
Update README.md Quick Start section 2
PrajwalHM-Gaargesh Aug 4, 2025
d8174c4
Address review comments by nircoe for README.md
PrajwalHM-Gaargesh Aug 5, 2025
3907829
Add the default source to the initialization section of the README.md.
PrajwalHM-Gaargesh Aug 6, 2025
9632bf3
Add the default source to the Thread safety section of the README.md.
PrajwalHM-Gaargesh Aug 6, 2025
79648b1
Address review comments
PrajwalHM-Gaargesh Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ target_link_libraries(your_target PRIVATE logcoe)
#include <logcoe.hpp>

int main() {
// Initialize with INFO level, console enabled, file disabled
logcoe::initialize(logcoe::LogLevel::INFO, true, false);
// Initialize with INFO level, no default source (empty string), console enabled, file disabled
// logs will be printed as [timestamp] [log_level]: <log_message>
logcoe::initialize(logcoe::LogLevel::INFO, std::string{}, true, false);

logcoe::info("Application started");
logcoe::warning("This is a warning message");
Expand All @@ -64,8 +65,9 @@ int main() {
#include <fstream>

int main() {
// Enable both console and file output with DEBUG level
logcoe::initialize(logcoe::LogLevel::DEBUG, true, true, "app.log");
// Enable both console and file output with DEBUG level and default source as logcoe
// logs will be printed as [timestamp] [log_level] [logcoe]: <log_message>
logcoe::initialize(logcoe::LogLevel::DEBUG, "logcoe", true, true, "app.log");

// Customize time format
logcoe::setTimeFormat("%H:%M:%S");
Expand Down Expand Up @@ -107,6 +109,7 @@ logcoe::initialize();
// Full configuration
logcoe::initialize(
logcoe::LogLevel::DEBUG, // Log level
"logcoe", // Default source
true, // Enable console
true, // Enable file
"application.log" // Filename
Expand Down Expand Up @@ -173,7 +176,7 @@ void worker_thread(int id) {
}

int main() {
logcoe::initialize(logcoe::LogLevel::INFO, false, true, "concurrent.log");
logcoe::initialize(logcoe::LogLevel::INFO, std::string{}, false, true, "concurrent.log");

std::vector<std::thread> workers;
for (int i = 0; i < 10; ++i) {
Expand Down Expand Up @@ -209,4 +212,4 @@ int main() {

## License

MIT License - see [LICENSE](LICENSE) file for details.
MIT License - see [LICENSE](LICENSE) file for details.
Loading