Skip to content

Commit

Permalink
Replaces README.md stub with proper README.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
StrongestNumber9 committed Feb 16, 2022
1 parent 882b953 commit d268405
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 1 deletion.
57 changes: 57 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
= Java RELP Server Library (rlp_03)

rlp_03 implements RELP server in Java

== License
AGPLv3 with link:https://github.com/teragrep/rlp_03/blob/master/LICENSE#L665-L670[additional permissions] granted in the license.

== Features
Current

- RELP Server

== Setting dependencies
[source, xml]
----
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<dependencies>
<!-- this library -->
<dependency>
<groupId>com.teragrep</groupId>
<artifactId>rlp_03</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
</project>
----

== Example

[source, java]
----
import com.teragrep.rlp_03.Server;
import com.teragrep.rlp_03.SyslogFrameProcessor;
import java.io.IOException;
import java.util.function.Consumer;
public class Main {
public static void main(String[] args) throws IOException, InterruptedException {
final Consumer<byte[]> cbFunction;
cbFunction = (message) -> {
System.out.println(new String(message));
};
int port = 1601;
Server server = new Server(port, new SyslogFrameProcessor(cbFunction));
server.start();
while (true) {
Thread.sleep(1000L);
}
}
}
----
1 change: 0 additions & 1 deletion README.md

This file was deleted.

0 comments on commit d268405

Please sign in to comment.