https://github.com/kosi-libs/Canard

Kotlin/Multiplatform lightweight logging library.
https://github.com/kosi-libs/Canard

android kmm kmm-library kodein kodein-framework kotlin kotlin-library kotlin-multiplatform

Last synced: 3 months ago
JSON representation

Kotlin/Multiplatform lightweight logging library.

• Host: GitHub
• URL: https://github.com/kosi-libs/Canard
• Owner: kosi-libs
• License: mit
• Created: 2019-04-26T05:44:28.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-10T13:55:25.000Z (5 months ago)
• Last Synced: 2024-02-10T14:38:24.125Z (5 months ago)
• Topics: android, kmm, kmm-library, kodein, kodein-framework, kotlin, kotlin-library, kotlin-multiplatform
• Language: Kotlin
• Homepage: https://kosi-libs.org/canard/
• Size: 18.4 MB
• Stars: 33
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• kmp-awesome - Canard - logger (Libraries / 📋 Log)
• awesome-list - kosi-libs/Canard - Kotlin/Multiplatform lightweight logging library. (Kotlin)

README

        
[![Maven Central](https://img.shields.io/maven-central/v/org.kodein.log/canard)](https://mvnrepository.com/artifact/org.kodein.log/canard)

[![Kotlin](https://img.shields.io/badge/Kotlin-1.9.21-blue.svg?style=flat&logo=kotlin)](https://kotlinlang.org)

![Github Actions](https://github.com/kosi-libs/Canard/actions/workflows/snapshot.yml/badge.svg)

[![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/kosi-libs/Canard/blob/master/LICENSE.txt)

[![Slack channel](https://img.shields.io/badge/Chat-Slack-green.svg?style=flat&logo=slack)](https://kotlinlang.slack.com/messages/kodein/)

# Canard - Kotlin Multiplatform Logging library

**Canard** is a lightweight Kotlin Multiplatform logging library with a simple API, working on: 

 - JVM / Android

 - iOS, as well as all Kotlin/Native targets

 - JavaScript / WasmJS

**Canard** allows you to:

- Easily set up logging in a Kotlin Multiplatform

- Log what you need on different levels

- Avoid worrying about platform-specific frontend implementations

**Canard** is a good choice because:

- It integrates nicely with all Kotlin/Multiplatform targets

- It has a straightforward design with a user-friendly and comprehensible API.

## Installation

```kotlin

repositories {

    mavenCentral()

}

kotlin {

    sourceSets {

        commonMain {

            dependencies {

                implementation("org.kodein.log:canard:{version}")

            }

        }

    }

}

```

## Example

```kotlin

// Simple example

val loggerFactory = LoggerFactory(defaultLogFrontend)

val logger = newLogger(loggerFactory)

logger.info { "Welcome to ..." }

logger.warning { "... the Canard documentation!" }

```

## Read more

See **[Canard documentation](https://kosi-libs.org/canard/)**.