Skip to content

Commit 8507a5a

Browse files
committed
Update doc
1 parent 45419d2 commit 8507a5a

File tree

2 files changed

+23
-57
lines changed

2 files changed

+23
-57
lines changed

README.md

Lines changed: 22 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,27 @@
1-
# fluent-logger-scala -A Scala structured logger for Fluentd-
1+
fluent-logger-scala [![Build Status](https://travis-ci.org/fluent/fluent-logger-scala.svg?branch=develop)](https://travis-ci.org/fluent/fluent-logger-scala)
2+
![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.fluentd/fluent-logger-scala_2.12/badge.svg) [![Scaladoc](http://javadoc-badge.appspot.com/org.fluentd/fluent-logger-scala_2.12.svg?label=scaladoc)](http://javadoc-badge.appspot.com/org.fluentd/fluent-logger-scala_2.12)
23

3-
[![Build Status](https://travis-ci.org/fluent/fluent-logger-scala.svg?branch=develop)](https://travis-ci.org/fluent/fluent-logger-scala)
4+
====
5+
Fluentd logger for Scala
46

57
Many web/mobile applications generate huge amount of event logs (c,f. login, logout, purchase, follow, etc). To analyze these event logs could be really valuable for improving the service. However, the challenge is collecting these logs easily and reliably.
68

7-
89
[Fluentd](http://github.com/fluent/fluentd) solves that problem by having: easy installation, small footprint, plugins, reliable buffering, log forwarding, etc.
910

1011
**fluent-logger-scala** is a Scala library, to record the events from Scala application, based on fluent-logger-java.
1112
Main difference between scala and java version is to support Scala Collection.
1213

1314
Please see [QuickStart](https://github.com/fluent/fluent-logger-scala/wiki/QuickStart) to get started!
1415

15-
## Installation(for scala 2.10.0 or later)
16-
17-
Add sonatype repository and dependencies to build.sbt file as follows:
18-
19-
resolvers += "Apache Maven Central Repository" at "http://repo.maven.apache.org/maven2/"
20-
21-
libraryDependencies += "org.fluentd" % "fluent-logger-scala_<scala_version>" % "0.6.0"
22-
23-
24-
Please replace ```<scala_version>``` with scala compiler version you use.
25-
Currently, ```<scala_version>``` can be replaced with 2.10 or 2.11.
26-
For instance,
27-
28-
libraryDependencies += "org.fluentd" % "fluent-logger-scala_2.10" % "0.6.0"
29-
30-
or
31-
32-
libraryDependencies += "org.fluentd" % "fluent-logger-scala_2.11" % "0.6.0"
33-
34-
## Installation(for scala 2.9)
35-
36-
We provide old version of fluent-logger-scala for scala 2.9.
37-
16+
## Usage
3817

39-
libraryDependencies += "org.fluentd" % "fluent-logger-scala_2.9.0" % "0.4.0"
40-
41-
or
42-
43-
libraryDependencies += "org.fluentd" % "fluent-logger-scala_2.9.1" % "0.4.0"
44-
45-
or
46-
47-
libraryDependencies += "org.fluentd" % "fluent-logger-scala_2.9.2" % "0.4.0"
18+
```scala
19+
# For Scala 2.11 and 2.12 (Since fluent-logger-scala 0.7.0)
20+
libraryDependencies += "org.fluentd" %% "fluent-logger-scala" % "(version)"
4821

22+
# For Scala 2.10 users (deprecated)
23+
libraryDependencies += "org.fluentd" %% "fluent-logger-scala" % "0.6.0"
24+
```
4925

5026

5127
## API
@@ -64,21 +40,18 @@ APIs base on fluent-logger-java.
6440
FluentLogger#flush()
6541
FluentLogger#close()
6642

67-
## How to Build from source
68-
69-
70-
## Build
7143

72-
./sbt update
73-
./sbt compile
44+
## For Developers
7445

75-
## Test
46+
```
47+
$ ./sbt
48+
> compile
49+
> test
50+
# cross Scala version testing
51+
> + test
52+
```
7653

77-
./sbt test
78-
79-
## For developers
80-
81-
### Publishing to sonatype repository
54+
### Publishing to Maven Central
8255

8356
Describe your account information in $HOME/.sbt/(sbt-version)/sonatype.sbt file:
8457

@@ -87,16 +60,9 @@ Describe your account information in $HOME/.sbt/(sbt-version)/sonatype.sbt file:
8760
"(Sonatype user name)",
8861
"(Sonatype password)")
8962

90-
Then publish a signed artifact to the Sonatype repository:
91-
92-
./sbt publishSigned
93-
94-
Make sure you are using a release version in build.sbt file. A SNAPSHOT version is deployed to the snapshot repostitory of Sonatype, which is not synched with Maven central.
95-
96-
After publishing, you can close, promote and drop the published repositorty with sonatypeRelease command:
97-
98-
./sbt sonatypeRelease
63+
The release command will publish signed artifacts to the Sonatype repository, and perform releasing to Maven Central:
9964

65+
./sbt release
10066

10167
## License and Copyright
10268

version.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
vertion in ThisBuild := "0.7.0-SNAPSHOT"
1+
version in ThisBuild := "0.7.0-SNAPSHOT"

0 commit comments

Comments
 (0)