From ae6951351afcc47e4959c403347b00ac4a147f4e Mon Sep 17 00:00:00 2001 From: Akihiro Kondo Date: Thu, 17 Dec 2015 12:56:22 +0900 Subject: [PATCH] README: Add usage --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/README.md b/README.md index 5dbfd64f..42f6b44d 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,53 @@ Status [![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.rakugakibox.springbootext/spring-boot-ext-logback-access/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.rakugakibox.springbootext/spring-boot-ext-logback-access) [![Circle CI](https://circleci.com/gh/akihyro/spring-boot-ext-logback-access.svg?style=shield)](https://circleci.com/gh/akihyro/spring-boot-ext-logback-access) + +Supported servlet containers +---------------------------- + +* Embedded Tomcat +* Embedded Jetty + +Usage +----- + +### Maven dependency: + +```xml + + net.rakugakibox.springbootext + spring-boot-ext-logback-access + 1.0 + +``` + +### Configuration properties (application.yml): + +```yml +logback.access: + config: "classpath:your-logback-access.xml" + # Auto-detected by default. + # => "classpath:logback-access-test.xml" + # => "classpath:logback-access.xml" + # => "classpath:net/rakugakibox/springbootext/logback/access/logback-access.xml" +``` + +### Logback-access configuration example (logback-access.xml) + +```xml + + + + common + + + + +``` + +See Also: [HTTP-access logs with logback-access, Jetty and Tomcat - Logback-access](http://logback.qos.ch/access.html) + +License +------- + +Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).