Add new wrapper and usage examples.

2020-11-18 17:38:19 +03:00 · 2020-11-18 17:38:19 +03:00 · cd82d3d888
commit cd82d3d888
parent 3f33d15879
3 changed files with 59 additions and 16 deletions
--- a/build.html
+++ b/build.html
@ -33,6 +33,9 @@ select.large { font-size: large; }
      <option>PHP</option>
      <option>Lua</option>
      <option>Ruby</option>
+      <option>Crystal</option>
+      <option>Haskell</option>
+      <option>Nim</option>
      <option>Clojure</option>
      <option>D</option>
      <option>Elixir</option>
@ -197,6 +200,9 @@ function getExampleAnchor(language) {
    case 'PHP':
    case 'Lua':
    case 'Ruby':
+    case 'Crystal':
+    case 'Haskell':
+    case 'Nim':
    case 'Clojure':
    case 'D':
    case 'Elixir':
--- a/example/README.md
+++ b/example/README.md
@ -25,6 +25,9 @@ Choose your preferred programming language to see examples of usage and a detail
 - [PHP](#php)
 - [Lua](#lua)
 - [Ruby](#ruby)
+- [Crystal](#crystal)
+- [Haskell](#haskell)
+- [Nim](#nim)
 - [Clojure](#clojure)
 - [Emacs Lisp](#emacslisp)
 - [D](#d)
@ -44,8 +47,8 @@ If you use modern Python >= 3.6, take a look at [python-telegram](https://github
 The wrapper uses the full power of asyncio, has a good documentation and has several examples. It can be installed through pip or used in a Docker container.
 You can also try a fork [python-telegram](https://github.com/iTeam-co/python-telegram) of this library.

-For older Python versions you can use [pytdlib](https://github.com/pytdlib/pytdlib) or [python-tdlib](https://github.com/andrew-ld/python-tdlib).
-These wrappers contain generators for TDLib API classes and basic classes for interaction with TDLib.
+For older Python versions you can use [pytdlib](https://github.com/pytdlib/pytdlib).
+This wrapper contains generator for TDLib API classes and basic interface for interaction with TDLib.

 You can also check out [example/python/tdjson_example.py](https://github.com/tdlib/td/tree/master/example/python/tdjson_example.py) and
 [tdlib-python](https://github.com/JunaidBabu/tdlib-python) for some very basic examples of TDLib JSON interface integration with Python.
@ -62,8 +65,8 @@ Convenient Node.js wrappers already exist for our JSON interface.
 For example, take a look at [Airgram](https://github.com/airgram/airgram) – modern TDLib framework for TypeScript/JavaScript, or
 at [tdl](https://github.com/Bannerets/tdl), which provides a convenient, fully-asynchronous interface for interaction with TDLib and contains a bunch of examples.

-You can also see [tglib](https://github.com/nodegin/tglib), [node-tdlib](https://github.com/wfjsw/node-tdlib), [tdlnode](https://github.com/fonbah/tdlnode),
-[Paper Plane](https://github.com/BlackSuited/paper-plane) and [node-tlg](https://github.com/dilongfa/node-tlg) for other examples of TDLib JSON interface integration with Node.js.
+You can also see [TdNode](https://github.com/puppy0cam/TdNode), [tglib](https://github.com/nodegin/tglib), [node-tdlib](https://github.com/wfjsw/node-tdlib), [tdlnode](https://github.com/fonbah/tdlnode),
+[Paper Plane](https://github.com/BlackSuited/paper-plane), or [node-tlg](https://github.com/dilongfa/node-tlg) for other examples of TDLib JSON interface integration with Node.js.

 TDLib can be used also from NativeScript through the [JSON](https://github.com/tdlib/td#using-json) interface.
 See [nativescript-tglib](https://github.com/arpit2438735/nativescript-tglib) as an example of a NativeScript library for building Telegram clients.
@ -94,20 +97,25 @@ You can also see [JTDLib](https://github.com/ErnyTech/JTDLib) for another exampl

 TDLib can be used from the Kotlin/JVM programming language through same way as in [Java](#java).

-You can also use [ktd](https://github.com/whyoleg/ktd) library with kotlin specific bindings.
+You can also use [ktd](https://github.com/whyoleg/ktd) library with Kotlin-specific bindings.
+
+See also [KtLib](https://github.com/nekohasekai/KtLib), which provides an automatically generated classes for TDLib API, and
+[td-ktx](https://github.com/tdlibx/td-ktx) - Kotlin coroutines wrapper for TDLib.

 <a name="csharp"></a>
 ## Using TDLib in C# projects

 TDLib provides a native [.NET](https://github.com/tdlib/td#using-dotnet) interface through `C++/CLI` and `C++/CX`.
+See [tdlib-netcore](https://github.com/dantmnf/tdlib-netcore) for a SWIG-like binding with automatically generated classes for TDLib API.
 See [example/uwp](https://github.com/tdlib/td/tree/master/example/uwp) for an example of building TDLib SDK for the Universal Windows Platform and an example of its usage from C#.
 See [example/csharp](https://github.com/tdlib/td/tree/master/example/csharp) for an example of building TDLib with `C++/CLI` support and an example of TDLib usage from C# on Windows.

 If you want to write a cross-platform C# application using .NET Core, see [tdsharp](https://github.com/egramtel/tdsharp). It uses our [JSON](https://github.com/tdlib/td#using-json) interface,
 provides an asynchronous interface for interaction with TDLib, automatically generated classes for TDLib API and has some examples.

-Also see [Unigram](https://github.com/UnigramDev/Unigram), which is a full-featured client rewritten from scratch in C# using TDLib SDK for Universal Windows Platform in less than 2 months, or
-[egram.tel](https://github.com/egramtel/egram.tel) – a cross-platform Telegram client written in C#, .NET Core, ReactiveUI and Avalonia.
+Also see [Unigram](https://github.com/UnigramDev/Unigram), which is a full-featured client rewritten from scratch in C# using TDLib SDK for Universal Windows Platform in less than 2 months,
+[egram.tel](https://github.com/egramtel/egram.tel) – a cross-platform Telegram client written in C#, .NET Core, ReactiveUI and Avalonia, or
+[telewear](https://github.com/telewear/telewear) - a Telegram client for Samsung watches.

 <a name="cxx"></a>
 ## Using TDLib in C++ projects
@ -117,14 +125,15 @@ TDLib has a simple and convenient C++11-interface for sending and receiving requ
 See [example/cpp](https://github.com/tdlib/td/tree/master/example/cpp) for an example of TDLib usage from C++.
 [td_example.cpp](https://github.com/tdlib/td/tree/master/example/cpp/td_example.cpp) contains an example of authorization, processing new incoming messages, getting a list of chats and sending a text message.

-See also the source code of [Depecher](https://github.com/blacksailer/depecher) – a Telegram app for Sailfish OS, and [TELEports](https://gitlab.com/ubports/apps/teleports) – a Qt-client for Ubuntu Touch, both of which are based on TDLib.
+See also the source code of [Depecher](https://github.com/blacksailer/depecher) – a Telegram app for Sailfish OS, [TELEports](https://gitlab.com/ubports/apps/teleports) – a Qt-client for Ubuntu Touch, or
+[tdlib-purple](https://github.com/ars3niy/tdlib-purple) - Telegram plugin for Pidgin, all of which are based on TDLib.

 <a name="swift"></a>
 ## Using TDLib in Swift projects

 TDLib can be used from the Swift programming language through the [JSON](https://github.com/tdlib/td#using-json) interface and can be linked statically or dynamically.

-See [TDLib-iOS](https://github.com/leoMehlig/TDLib-iOS), which provide a convenient TDLib client with automatically generated and fully-documented classes for all TDLib API methods and objects.
+See [TDLib-iOS](https://github.com/leoMehlig/TDLib-iOS) or [tdlib-swift](https://github.com/modestman/tdlib-swift), which provide convenient TDLib clients with automatically generated and fully-documented classes for all TDLib API methods and objects.

 See [example/swift](https://github.com/tdlib/td/tree/master/example/swift) for an example of a macOS Swift application.
 See [example/ios](https://github.com/tdlib/td/tree/master/example/ios) for an example of building TDLib for iOS, watchOS, tvOS, and macOS.
@ -152,15 +161,19 @@ TDLib can be used from the Dart programming language through the [JSON](https://

 See [dart_tdlib](https://github.com/periodicaidan/dart_tdlib) or [Dart wrapper for TDLib](https://github.com/tdlib/td/pull/708/commits/237060abd4c205768153180e9f814298d1aa9d49) for an example of a TDLib Dart bindings through FFI.

-See [project.scarlet](https://github.com/aaugmentum/project.scarlet) or [tdlib-dart](https://github.com/triedcatched/tdlib-dart) for an example of using TDLib from Dart.
+See [project.scarlet](https://github.com/aaugmentum/project.scarlet), [tdlib](https://github.com/i-Naji/tdlib), [tdlib](https://github.com/pqhaz/tdlib),
+[tdlib-dart](https://github.com/drewpayment/tdlib-dart), [tdlib-dart](https://github.com/triedcatched/tdlib-dart), or [telegram-service](https://github.com/igorder-dev/telegram-service) for examples of using TDLib from Dart.

 <a name="rust"></a>
 ## Using TDLib in Rust projects

 TDLib can be used from the Rust programming language through the [JSON](https://github.com/tdlib/td#using-json) interface.

+See [tdlib-rs](https://github.com/agnipau/tdlib-rs], which contains automatically generated classes for all TDLib API methods and objects.
+
 See [rtdlib](https://github.com/fewensa/rtdlib), [tdlib-rs](https://github.com/d653/tdlib-rs), [tdlib-futures](https://github.com/yuri91/tdlib-futures),
-[rust-tdlib](https://github.com/lattenwald/rust-tdlib) or [tdjson-rs](https://github.com/mersinvald/tdjson-rs) for an example of TDLib Rust bindings.
+[tdlib-sys](https://github.com/nuxeh/tdlib-sys), [rust-tdlib](https://github.com/lattenwald/rust-tdlib), or
+[tdjson-rs](https://github.com/mersinvald/tdjson-rs) for examples of TDLib Rust bindings.

 <a name="erlang"></a>
 ## Using TDLib in Erlang projects
@ -178,7 +191,8 @@ See also [tdlib-schema](https://github.com/aurimasniekis/php-tdlib-schema) - a g

 For older PHP versions you can use TDLib by wrapping its functionality in a PHP extension.

-See [phptdlib](https://github.com/yaroslavche/phptdlib), [tdlib](https://github.com/aurimasniekis/php-ext-tdlib) or [PIF-TDPony](https://github.com/danog/pif-tdpony) for examples of such extensions which provide access to TDLib from PHP.
+See [phptdlib](https://github.com/yaroslavche/phptdlib), [tdlib](https://github.com/aurimasniekis/php-ext-tdlib), or [PIF-TDPony](https://github.com/danog/pif-tdpony)
+for examples of such extensions which provide access to TDLib from PHP.

 See [tdlib-bundle](https://github.com/yaroslavche/tdlib-bundle) – a Symfony bundle based on [phptdlib](https://github.com/yaroslavche/phptdlib).

@ -187,7 +201,8 @@ See [tdlib-bundle](https://github.com/yaroslavche/tdlib-bundle) – a Symfony bu

 TDLib can be used from the Lua programming language through the [JSON](https://github.com/tdlib/td#using-json) interface.

-See [tdlua](https://github.com/giuseppeM99/tdlua) for examples of TDLib Lua bindings and basic usage examples.
+See [luajit-tdlib](https://github.com/Rami-Sabbagh/luajit-tdlib), [tdlua](https://github.com/giuseppeM99/tdlua), [Luagram](https://github.com/Luagram/LuagramProject), or
+[luajit-tdlib](https://github.com/Playermet/luajit-tdlib) for examples of TDLib Lua bindings and basic usage examples.

 See also [tdbot](https://github.com/vysheng/tdbot), which makes all TDLib features available from Lua scripts.

@ -205,12 +220,34 @@ TDLib can be used from the Ruby programming language through the [JSON](https://

 See [tdlib-ruby](https://github.com/centosadmin/tdlib-ruby) for examples of Ruby bindings and a client for TDLib.

+<a name="Crystal"></a>
+## Using TDLib in Crystal projects
+
+TDLib can be used from the Crystal programming language through the [JSON](https://github.com/tdlib/td#using-json) interface.
+
+See [Proton](https://github.com/protoncr/proton) for examples of Crystal bindings with automatically generated types for all TDLib API methods and objects.
+
+<a name="haskell"></a>
+## Using TDLib in Haskell projects
+
+TDLib can be used from the Haskell programming language.
+
+See [haskell-tdlib](https://github.com/mejgun/haskell-tdlib) or [tdlib](https://github.com/poscat0x04/tdlib) for examples of such usage and Haskell wrappers for TDLib.
+This library contains automatically generated Haskell types for all TDLib API methods and objects.
+
+<a name="nim"></a>
+## Using TDLib in Nim projects
+
+TDLib can be used from the Nim programming language.
+
+See [telenim](https://github.com/Yardanico/telenim) for example of such usage and a Nim wrapper for TDLib.
+
 <a name="clojure"></a>
 ## Using TDLib in Clojure projects

 TDLib can be used from the Clojure programming language through the [JSON](https://github.com/tdlib/td#using-json) interface.

-See [clojure-tdlib-json-wrapper](https://github.com/MityaSaray/clojure-tdlib-json-wrapper) for an example of TDLib Clojure bindings.
+See [clojure-tdlib-json-wrapper](https://github.com/MityaSaray/clojure-tdlib-json) for an example of TDLib Clojure bindings.

 <a name="emacslisp"></a>
 ## Using TDLib in Emacs Lisp projects
@ -225,7 +262,7 @@ See [telega.el](https://github.com/zevlg/telega.el) for an example of a GNU Emac
 TDLib can be used from the Elixir programming language.

 See [Elixir TDLib](https://gitlab.com/Fnux/elixir-tdlib) or [Elixir TDLib](https://github.com/QuantLayer/elixir-tdlib) for examples of such usage and an Elixir client for TDLib.
-This library contains automatically generated and fully-documented classes for all TDLib API methods and objects.
+These libraries contain automatically generated and fully-documented classes for all TDLib API methods and objects.

 <a name="1s"></a>
 ## Using TDLib from 1С:Enterprise
--- a/example/swift/src/main.swift
+++ b/example/swift/src/main.swift
@ -9,7 +9,7 @@ import Foundation

 // TDLib Client Swift binding
 class TdClient {
-    var client_id = td_create_client_id()!
+    var client_id = td_create_client_id()
    let tdlibMainLoop = DispatchQueue(label: "TDLib")
    let tdlibQueryQueue = DispatchQueue(label: "TDLibQuery")
    var queryF = Dictionary<Int64, (Dictionary<String,Any>)->()>()