Skip to content

Commit

Permalink
README.md updated
Browse files Browse the repository at this point in the history
  • Loading branch information
jupf committed Nov 27, 2017
1 parent 4ba1838 commit 798dfea
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
@@ -1,5 +1,5 @@
# StaticLog
[![Kotlin](https://img.shields.io/badge/Kotlin-1.0.6-blue.svg?style=flat) ](https://kotlinlang.org/) [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat) ](https://github.com/jupf/staticlog/blob/master/LICENSE) [![Dependency Status](https://www.versioneye.com/user/projects/56cc29b518b2710403dfed86/badge.svg)](https://www.versioneye.com/user/projects/56cc29b518b2710403dfed86) [ ![Download](https://api.bintray.com/packages/jupf/maven/StaticLog/images/download.svg?style=flat) ](https://bintray.com/jupf/maven/StaticLog/_latestVersion)
[![Kotlin](https://img.shields.io/badge/Kotlin-1.1.61-blue.svg?style=flat) ](https://kotlinlang.org/) [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat) ](https://github.com/jupf/staticlog/blob/master/LICENSE) [![Dependency Status](https://www.versioneye.com/user/projects/56cc29b518b2710403dfed86/badge.svg)](https://www.versioneye.com/user/projects/56cc29b518b2710403dfed86) [ ![Download](https://api.bintray.com/packages/jupf/maven/StaticLog/images/download.svg?style=flat) ](https://bintray.com/jupf/maven/StaticLog/_latestVersion)

StaticLog is a super lightweight logging library implemented in pure Kotlin ([https://kotlinlang.org](https://kotlinlang.org/)). It is designed to be used in Kotlin, Java and Android.
It is for formatting standard output comfortably without the need to construct a Logger object. But it's also no problem to create one.
Expand All @@ -18,12 +18,14 @@ Yes, the occurrence of the log message is clickable!
- [Tag Filtering in Kotlin](#tag-filtering-in-kotlin)
- [Log instances in Kotlin](#log-instances-in-kotlin)
- [FormatBuilders in Kotlin](#formatbuilders-in-kotlin)
- [Custom Printers in Kotlin](#custom-printers-in-kotlin)
- [StaticLog in Java](#staticlog-in-java)
- [Logging in Java](#logging-in-java)
- [Formatting Output in Java](#formatting-output-in-java)
- [Tag Filtering in Java](#tag-filtering-in-java)
- [Log instances in Java](#log-instances-in-java)
- [FormatBuilders in Java](#formatbuilders-in-java)
- [Custom Printers in Java](#custom-printers-in-java)
- [StaticLog in Android](#staticlog-in-android)

## Getting Started
Expand All @@ -35,7 +37,7 @@ This library is uploaded to jCenter and Maven Central.

```gradle
dependencies {
compile 'io.github.jupf.staticlog:staticlog:2.1.9'
compile 'io.github.jupf.staticlog:staticlog:2.2.0'
}
```

Expand All @@ -51,7 +53,7 @@ If you ___dont___ have the Kotlin runtime already present in your project, use t

```gradle
dependencies {
compile 'io.github.jupf.staticlog:staticlog-java:2.1.9'
compile 'io.github.jupf.staticlog:staticlog-java:2.2.0'
}
```

Expand Down Expand Up @@ -148,6 +150,10 @@ Here are all possible FormatBuilders:
| tab(X: Integer) | Prints X tabs |
| text(S: String) | Prints the String S |

### Custom Printers in Kotlin

tbd

## StaticLog in Java

You can find the example source code [here](https://github.com/jupf/staticlog/blob/master/src/main/java/example/Example.java).
Expand Down Expand Up @@ -231,6 +237,10 @@ Here are all possible FormatBuilders:
| tab(X: Integer) | Prints X tabs |
| text(S: String) | Prints the String S |

### Custom Printers in Java

tbd

## StaticLog in Android

StaticLog automatically detects Android VMs and switches its output to the Android logger.
Expand Down

0 comments on commit 798dfea

Please sign in to comment.