From 9c7c2a2cadd943c09a112314f3229f8daf512c95 Mon Sep 17 00:00:00 2001 From: Temirkhan Myrzamadi Date: Wed, 19 Feb 2020 07:41:59 +0600 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1259d607..11bcedfe 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

teloxide

- + @@ -11,10 +11,28 @@ + + + A full-featured framework that empowers you to easily build [Telegram bots](https://telegram.org/blog/bot-revolution) using the [`async`/`.await`](https://rust-lang.github.io/async-book/01_getting_started/01_chapter.html) syntax in [Rust](https://www.rust-lang.org/). It handles all the difficult stuff so you can focus only on your business logic.
+## Table of contents + - [Features](https://github.com/teloxide/teloxide#features) + - [Getting started](https://github.com/teloxide/teloxide#getting-started) + - [Examples](https://github.com/teloxide/teloxide#examples) + - [The ping-pong bot](https://github.com/teloxide/teloxide#the-ping-pong-bot) + - [Commands](https://github.com/teloxide/teloxide#commands) + - [Guess a number](https://github.com/teloxide/teloxide#guess-a-number) + - [More examples!](https://github.com/teloxide/teloxide#more-examples) + - [Recommendations](https://github.com/teloxide/teloxide#recommendations) + - [FAQ](https://github.com/teloxide/teloxide#faq) + - [Where I can ask questions?](https://github.com/teloxide/teloxide#where-i-can-ask-questions) + - [Why Rust?](https://github.com/teloxide/teloxide#why-rust) + - [Community bots](https://github.com/teloxide/teloxide#community-bots) + - [Contributing](https://github.com/teloxide/teloxide#contributing) + ## Features - **Type-safe.** teloxide leverages the Rust's type system with two serious implications: resistance to human mistakes and tight integration with IDEs. Write fast, avoid debugging as much as possible. @@ -306,5 +324,15 @@ See [examples/dialogue_bot](https://github.com/teloxide/teloxide/blob/master/exa The second one produces very strange compiler messages because of the `#[tokio::main]` macro. However, the examples in this README use the second variant for brevity. +## FAQ +### Where I can ask questions? +[Issues](https://github.com/teloxide/teloxide/issues) is a good place for well-formed questions, for example, about the library design, enhancements, bug reports. But if you can't compile your bot due to compilation errors and need a quick help, feel free to ask in our official group: https://t.me/teloxide. + +### Why Rust? +Most programming languages have their own implementations of Telegram bots frameworks, so why not Rust? We think Rust provides enough good ecosystem and the language itself to be suitable for writing bots. + +## Community bots +Feel free to push your own bot into our collection: https://github.com/teloxide/community-bots. Later you will be able to play with them right in our official chat: https://t.me/teloxide. + ## Contributing See [CONRIBUTING.md](https://github.com/teloxide/teloxide/blob/master/CONTRIBUTING.md).