tdlight-team/tdlight-java
tdlight-team/tdlight-java
1
2
Fork 0
Code Issues Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Andrea Cavalli 2023-05-15 00:10:23 +02:00
parent 9a1c284d69
commit 98273f1d47
3 changed files with 35 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -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:
<!-- Add the following dependencies -->
<dependency>
<groupId>it.tdlight</groupId>
<artifactId>tdlight-java</artifactId> <!-- Java 8 is supported if you use the following dependency classifier: <classifier>jdk8</classifier> -->
<artifactId>tdlight-java</artifactId>
<!-- Java 8 is supported if you use the following dependency classifier: <classifier>jdk8</classifier> -->
<!-- don't specify the version here -->
</dependency>
<!-- Example linux amd64 ssl1 natives -->
<dependency>
<groupId>it.tdlight</groupId>
<artifactId>tdlight-natives-linux-amd64</artifactId>
<artifactId>tdlight-natives</artifactId>
<classifier>linux_amd64_ssl1</classifier>
<!-- don't specify the version here -->
</dependency>
<!-- Include other native versions that you want, for example for windows, osx, ... -->
<!-- Example windows amd64 natives -->
<dependency>
<groupId>it.tdlight</groupId>
<artifactId>tdlight-natives</artifactId>
<classifier>windows_amd64</classifier>
<!-- don't specify the version here -->
</dependency>
<!-- ... -->
<!-- Include other native classifiers, for example linux_amd64_ssl3, macos_amd64, ... -->
</dependencies>
</project>
@ -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

7
example/src/main/java/it/tdlight/example/Example.java
View File

@ -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);

6
example/src/main/resources/log4j2.xml
View File

@ -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">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout
@ -13,8 +13,8 @@
</Appenders>
<Loggers>
<Logger name="it.tdlight.TDLight" level="ERROR" additivity="false" />
<Root level="INFO">
<Logger name="it.tdlight.TDLight" level="WARN" additivity="false" />
<Root level="DEBUG">
<AppenderRef ref="Console"/>
</Root>
</Loggers>