Rewrite ReadMe
This commit is contained in:
Andrea Cavalli
parent
6e04ab73dd
commit
4c101009ff
|
|
@ -0,0 +1,16 @@
|
|||
Copyright (C) 2018 Ernesto Castellotti <erny.castell@gmail.com>
|
||||
|
||||
Ernesto Castellotti is the copyright holder of this software, for
|
||||
any need, do not hesitate to contact him.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program in the file called "LICENSE". If not, contact the copyright holder.
|
||||
101
README.md
101
README.md
|
|
@ -1,26 +1,80 @@
|
|||
LICENSE
|
||||
=======
|
||||
JTDLib, an wrapper of Tdlib for interaction with TDLib.
|
||||
TDLight Java Wrapper
|
||||
====================
|
||||
|
||||
Copyright (C) 2018 Ernesto Castellotti <erny.castell@gmail.com>
|
||||
|
||||
Ernesto Castellotti is the copyright holder of this software, for
|
||||
any need, do not hesitate to contact him.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License.
|
||||
## Requirements
|
||||
JVM: Oracle JVM and OpenJDK
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Lesser General Public License for more details.
|
||||
Java versions: Java 10, 11, 12, 13, 14
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program in the file called "LICENSE". If not, contact the copyright holder.
|
||||
|
||||
LIBRARIES/EXTERNAL CODE
|
||||
=======================
|
||||
Operating system: Windows, Linux
|
||||
|
||||
Supported CPU architectures: amd64 (linux, windows), aarch64 (linux)
|
||||
|
||||
Required libraries for linux: OpenSSL and zlib
|
||||
|
||||
## Including TDLight in a project
|
||||
Maven configuration example to use this version of tdlight-java:
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>tdlight-gihtub</id>
|
||||
<name>GitHub TDLight Team Apache Maven Packages</name>
|
||||
<url>https://maven.pkg.github.com/tdlight-team/tdlight-java</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>it.ernytech</groupId>
|
||||
<artifactId>tdlib</artifactId>
|
||||
<version>REPLACE_WITH_LATEST_VERSION</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
Gradle configuration example to use this version of tdlight-java:
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url "https://maven.pkg.github.com/tdlight-team/tdlight-java" }
|
||||
}
|
||||
dependencies {
|
||||
implementation 'com.github.tdlight-team.tdlight-java:tdlib:REPLACE_WITH_LATEST_VERSION'
|
||||
}
|
||||
```
|
||||
|
||||
Replace `REPLACE_WITH_LATEST_VERSION` with the latest version of tdlight, you can find it on the **Releases** tab on github.
|
||||
|
||||
## Usage
|
||||
Simple initialization of a native TDLib client
|
||||
```java
|
||||
import java.io.File;
|
||||
|
||||
import it.tdlight.tdlight.Client;
|
||||
import it.tdlight.tdlight.Init;
|
||||
import it.tdlight.tdlight.Log;
|
||||
|
||||
public class Example {
|
||||
public static void main(String[] args) {
|
||||
// Initialize TDLight native libraries
|
||||
Init.start();
|
||||
|
||||
// Set TDLib log level to 1
|
||||
Log.setVerbosityLevel(1);
|
||||
|
||||
// Uncomment this line to print TDLib logs to a file
|
||||
// Log.setFilePath("logs" + File.separatorChar + "tdlib.log");
|
||||
|
||||
Client client = new Client();
|
||||
|
||||
// Initialize the TDLib client
|
||||
client.initializeClient();
|
||||
|
||||
// Now you can use the client
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## About
|
||||
#### Libraries and external code
|
||||
Telegram Tdlib-TD Copyright owner and contributors:
|
||||
- Aliaksei Levin <levlam@telegram.org>
|
||||
- Arseny Smirnov <arseny30@gmail.com>
|
||||
|
|
@ -31,4 +85,9 @@ Telegram Tdlib-TD Copyright owner and contributors:
|
|||
- Felix Krause <github@krausefx.com>
|
||||
- Mark
|
||||
|
||||
TDLib is licensed under the terms of the Boost Software License
|
||||
#### License
|
||||
TDLight is licensed by Andrea Cavalli <andrea@cavallium.it> under the terms of the GNU Lesser General Public License 3
|
||||
|
||||
JTDlib is licensed by Ernesto Castellotti under the terms of the GNU Lesser General Public License 3
|
||||
|
||||
TDLib is licensed by Aliaksei Levin Ale under the terms of the Boost Software License
|
||||
Loading…
Reference in New Issue