From 98273f1d474073e7dcf49803ed70cd4c82235051 Mon Sep 17 00:00:00 2001 From: Andrea Cavalli Date: Mon, 15 May 2023 00:10:23 +0200 Subject: [PATCH] Update README --- README.md | 48 +++++++++++-------- .../main/java/it/tdlight/example/Example.java | 7 +-- example/src/main/resources/log4j2.xml | 6 +-- 3 files changed, 35 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 67ba9cb..9fa0ed3 100644 --- a/README.md +++ b/README.md @@ -15,21 +15,19 @@ ## 💻 Supported platforms -**Java versions**: from Java 17 to Java 19+ (Java 8 is supported if you use the following dependency classifier: `jdk8`) +**Java versions**: from Java 17 to Java 19+ (Java 8 to 16 is supported if you use the following dependency classifier: `jdk8`) **Operating systems**: Linux, Windows, MacOS **CPU architectures**: -- i386/x86 (Linux, Windows) -- amd64/x86_64 (Linux, Windows, OSX) +- amd64/x86_64 (Linux, Windows, MacOS) - armhf/armv7 (Linux) - aarch64/armv8/arm64 (Linux) -- s390x (Linux) - ppc64el/ppc64le (Linux) ## 📚 Required libraries -- **Linux: OpenSSL, zlib** +- **Linux: libc++, OpenSSL1/OpenSSL3, zlib** - **MacOS: OpenSSL** - **Windows: [Microsoft Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe)** @@ -84,15 +82,26 @@ If you are using Maven, edit your `pom.xml` file as below: it.tdlight - tdlight-java + tdlight-java + + it.tdlight - tdlight-natives-linux-amd64 + tdlight-natives + linux_amd64_ssl1 - + + + it.tdlight + tdlight-natives + windows_amd64 + + + + @@ -114,9 +123,9 @@ dependencies { implementation platform('it.tdlight:tdlight-java-bom:VERSION') // do not specify the versions on the dependencies below! - implementation 'it.tdlight:tdlight-java' // Java 8 is supported if you use the following dependency classifier: `jdk8` - implementation 'it.tdlight:tdlight-natives-linux-amd64' - // Include other native versions that you want, for example for windows, osx, ... + implementation 'it.tdlight:tdlight-java:VERSION' // Java 8 is supported if you use the following dependency classifier: `jdk8` + implementation 'it.tdlight:tdlight-natives:VERSION:linux_amd64_ssl1' + // Include other native classifiers, for example linux_amd64_ssl3, macos_amd64, ... --> } ``` @@ -125,16 +134,15 @@ it [here](https://github.com/tdlight-team/tdlight-java/releases). ## ⚒ Native dependencies -To use TDLight Java you need to include one or more native dependencies: +To use TDLight Java you need to include the native libraries, by specifying one of the following classifier for each tdlight-natives dependency: -- `tdlight-natives-linux-amd64` -- `tdlight-natives-linux-aarch64` -- `tdlight-natives-linux-x86` -- `tdlight-natives-linux-armhf` -- `tdlight-natives-linux-ppc64le` -- `tdlight-natives-linux-s390x` -- `tdlight-natives-windows-amd64` -- `tdlight-natives-osx-amd64` +- `linux_amd64_ssl1` +- `linux_amd64_ssl3` +- `linux_arm64_ssl1` +- `linux_arm64_ssl3` +- `linux_ppc64le_ssl3` +- `windows_amd64` +- `macos_amd64` ## Usage diff --git a/example/src/main/java/it/tdlight/example/Example.java b/example/src/main/java/it/tdlight/example/Example.java index b6a234f..1a68494 100644 --- a/example/src/main/java/it/tdlight/example/Example.java +++ b/example/src/main/java/it/tdlight/example/Example.java @@ -44,8 +44,6 @@ public final class Example { // Configure the client TDLibSettings settings = TDLibSettings.create(apiToken); - // This is an example, remove this line to use the real telegram datacenters! - settings.setUseTestDatacenter(true); // Configure the session directory Path sessionPath = Paths.get("example-tdlight-session"); @@ -56,7 +54,10 @@ public final class Example { SimpleTelegramClientBuilder clientBuilder = clientFactory.builder(settings); // Configure the authentication info - SimpleAuthenticationSupplier authenticationData = AuthenticationSupplier.testUser(7381); // Replace with AuthenticationSupplier.consoleLogin(), or .user(xxx), or .bot(xxx); + // Replace with AuthenticationSupplier.consoleLogin(), or .user(xxx), or .bot(xxx); + SimpleAuthenticationSupplier authenticationData = AuthenticationSupplier.testUser(7381); + // This is an example, remove this line to use the real telegram datacenters! + settings.setUseTestDatacenter(true); // Add an example update handler that prints when the bot is started clientBuilder.addUpdateHandler(TdApi.UpdateAuthorizationState.class, Example::onUpdateAuthorizationState); diff --git a/example/src/main/resources/log4j2.xml b/example/src/main/resources/log4j2.xml index ca0e2fa..4a16be2 100644 --- a/example/src/main/resources/log4j2.xml +++ b/example/src/main/resources/log4j2.xml @@ -4,7 +4,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://logging.apache.org/log4j/2.0/config https://raw.githubusercontent.com/apache/logging-log4j2/log4j-2.16.0/log4j-core/src/main/resources/Log4j-config.xsd" - status="INFO"> + status="DEBUG"> - - + +