/VLogX

A visual logger for Android

Primary LanguageKotlin

VlogX

-----------------------------------------------------

Maintained

Maintained

JitPack

⚡ Latest Version: 1.0.0 🔰

  • Send log to VLogX while the application is in Debug Mode only.
  • Simple APIs to show and manage logs.
  • Allows to clear existing logs before sending new a log.
  • Auto close the log view by calling specific API or press the close button.

-----------------------------------------------------

Installation

➤ Step 1:

Add the JitPack repository to your build file .

    allprojects {
        repositories {
            maven { url 'https://jitpack.io' }
        }
    }

➤ Step 2:

Add the dependency.

    dependencies {
            implementation 'com.github.rommansabbir:vlogx:1.0.0'
    }

➤ Step 3:

Initialize VLogX from your Application.onCreate()

    VLogXService.init(this)

➤ Step 4:

  • Send a new log.
    sendLog("This is our first log :D *-*")
  • Clear existing logs.
    clearLog()
  • Clear existing and exit VLogX.
    clearAndCloseLog()

-----------------------------------------------------

Notes:

  • VLogX is desgined to work only in Debug Mode to prevent showing senstive logs to the product users.

-----------------------------------------------------

Contributors:

  • Amanullah Sarker
  • Romman Sabbir

-----------------------------------------------------

License

Apache Version 2.0

Copyright (C) 2023 VLogX

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.