Skip to content
This repository has been archived by the owner on Mar 18, 2022. It is now read-only.

Commit

Permalink
feat: add usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
xtex committed Oct 1, 2021
1 parent 62a3891 commit d949e3e
Showing 1 changed file with 90 additions and 0 deletions.
90 changes: 90 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# LibSlf4jCompat

![GitHub commit activity](https://img.shields.io/github/commit-activity/y/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub contributors](https://img.shields.io/github/contributors/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub release (latest by date)](https://img.shields.io/github/v/release/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub forks](https://img.shields.io/github/forks/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub Repo stars](https://img.shields.io/github/stars/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub](https://img.shields.io/github/license/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub issues](https://img.shields.io/github/issues/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub pull requests](https://img.shields.io/github/issues-pr/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub language count](https://img.shields.io/github/languages/count/YertinMC/LibSlf4jCompat?style=flat-square)![GitHub Workflow Status](https://img.shields.io/github/workflow/status/YertinMC/LibSlf4jCompat/Build?style=flat-square)

This plugin adds slf4j to Bukkit servers.

## Reason
Expand All @@ -20,6 +22,94 @@ This plugin provided three jars:
- API and JUL binding(for [13w38c](https://minecraft.fandom.com/wiki/Java_Edition_13w38c) and below, or 1.6.4 and below)
- API and Log4j binding(for [13w39a](https://minecraft.fandom.com/wiki/Java_Edition_13w39a) to [21w20a](https://minecraft.fandom.com/wiki/Java_Edition_21w20a), or 1.7 to 1.16.5)

## Using

### For user

You can download the correct version(see [Reason](#Reason)) of release jar here and put it into `plugins` directory of the server.

### For developer

![GitHub release (latest by date)](https://img.shields.io/github/v/release/YertinMC/LibSlf4jCompat?style=flat-square)

#### Gradle

##### JitPack Repository

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

##### Dependency

```groovy
dependencies {
implementation 'top.yertinmc:LibSlf4jCompat:{{VERSION}}'
}
```

#### Maven

##### JitPack Repository

Add this to your `pom.xml`:

````xml
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
````

##### Dependency

Then, add this:

```xml
<dependency>
<groupId>top.yertinmc</groupId>
<artifactId>LibSlf4jCompat</artifactId>
<version>{{VERSION}}</version>
<scope>compile</scope>
</dependency>
```

#### SBT

##### Resolver

Add it in your build.sbt at the end of resolvers:

```scala
resolvers += "jitpack" at "https://jitpack.io"
```

##### Dependency

```scala
libraryDependencies += "top.yertinmc" % "LibSlf4jCompat" % "{{VERSION}}"
```

#### leiningen

##### JitPack Repository

Add it in your project.clj at the end of repositories:

```scala
:repositories [["jitpack" "https://jitpack.io"]]
```

##### Dependency

```scala
:dependencies [[top.yertinmc/LibSlf4jCompat "{{VERSION}}"]]
```



## LICENSE

This project licensed under MIT license(same as slf4j).
Expand Down

0 comments on commit d949e3e

Please sign in to comment.