From e0e232199497581589b00e23a5f99c580b8444e0 Mon Sep 17 00:00:00 2001 From: Satish Date: Thu, 22 Apr 2021 18:04:09 +0800 Subject: [PATCH] update README.md. --- README.md | 64 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 36 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 4adf2bf..9dc1528 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,9 @@ -Introduction +# Introduction Logger: Simple, pretty and powerful logger -Installation tutorial -Logger can be added to any sample app by adding the below dependencies in gradle. - -1. Add dependency in build.gradle file, and include the library jar/har in libs: -``` -dependencies { - implementation fileTree(dir: 'libs', include:['*.jar', '*.har']) - implementation project(':logger') - testCompile'junit:junit:4.12' - } - -``` -2. gradle - ``` - allprojects{ - repositories{ - mavenCentral() - } - } - implementation 'io.openharmony.tpc.thirdlib:logger:1.0.0' - ``` - -Usage Instructions +# Usage Instructions 1. A sample project which provides runnable code examples that demonstrate uses of the classes in this project is available in the entity/ folder. - 2.Initialize -``` Logger.addLogAdapter(new HarmonyLogAdapter()); And use @@ -76,7 +52,7 @@ Logger.addLogAdapter(new HarmonyLogAdapter() { return BuildConfig.DEBUG; } }); -``` + More @@ -84,7 +60,39 @@ Use filter for a better result. PRETTY_LOGGER or your custom tag Make sure that wrap option is disabled You can also simplify output by changing settings. -License +# Installation Instructions + +Library Dependencies + +1. For using Logger module in your sample application. + +Modify entry build.gradle as below : + +dependencies { + implementation fileTree(dir: 'libs', include:['*.jar', '*.har']) + implementation project(':logger') + } + +2. For using Logger in separate application, add the below dependencies and include "Logger.har" in libs folder of "entry" module : + + Modify entry build.gradle as below : + ``` + dependencies { + implementation fileTree(dir: 'libs', include: ['*.har']) + } + ``` + +3. For using Logger from a remote repository in separate application, add the below dependencies: + + Modify entry build.gradle as below : + ``` + dependencies { + implementation fileTree(dir: 'libs', include: ['*.har']) + implementation 'io.openharmony.tpc.thirdlib:logger:1.0.0' + } + + +# License Copyright 2018 Orhan Obut Licensed under the Apache License, Version 2.0 (the "License"); -- Gitee