From 045c31af3263827460147fbe8818ea25e27643f4 Mon Sep 17 00:00:00 2001 From: Desiders Date: Sat, 3 Feb 2024 15:33:46 +0300 Subject: [PATCH] Move `README.md` to `telers` --- README.md | 56 +--------------------------------------- telers/README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 55 deletions(-) create mode 100644 telers/README.md diff --git a/README.md b/README.md index e89471b..fbd8e0c 100644 --- a/README.md +++ b/README.md @@ -1,55 +1 @@ -
- -

telers

- - - - - - - - - - - -

-An asynchronous framework for Telegram Bot API written in Rust -

- -
- -

- -Telers make it easy to create Telegram bots in Rust. - -Before you start, make sure that you have a basic understanding of the [Telegram Bot API](https://core.telegram.org/bots/api), because types and methods in the library have the same fields and types as in the documentation. - -## Highlights - - **Asynchronous**. Built on top of [Tokio](https://tokio.rs/), a powerful asynchronous runtime. - - **Easy to use**. Provides a simple and intuitive API for creating bots. - - **Based on** [aiogram](https://github.com/aiogram/aiogram/). Inspired by the framework written in Python and tries to provide a similar functionality. - - **Routers**, **Middlewares**, **Filters** and **Handlers**. Provides a powerful system of routers, middlewares, filters and handlers to make your code more readable and maintainable, and simplify the creation of bots. - - **Extractors**. Have similar system of extractors as in [axum](https://docs.rs/axum/latest/axum/extract/) and [actix](https://actix.rs/docs/extractors/). - -## Examples - - [Echo bot](examples/echo_bot). This example shows how to create an echo bot. - - [Text formatting](examples/text_formatting). This example shows how to format text. - - [Text case filters](examples/text_case_filters). This example shows how to create text case filters. - - [Stats updates middleware](examples/stats_incoming_updates_middleware). This example shows how to create a middleware that count incoming updates. - - [Context](examples/from_event_and_context). This example shows how to extract data from event and context and use it in handlers. - - [Input file](examples/input_file). This example shows how to send files by the bot. - - [Finite state machine](examples/finite_state_machine). This example shows how to use a finite state machine (conversation). - - [Router tree](examples/router_tree). This example shows how to create a router tree. - - [Bot http client](examples/bot_http_client). This example shows how to set a custom bot HTTP client. - - [Axum and echo bot](examples/axum_and_echo_bot). This example shows how to create an echo bot and run it concurrently with polling `axum` server. - -You may consider checking out [this directory](examples) for more examples. - -## Community -### Telegram -- 🇺🇸 [@telers_en](https://t.me/telers_en) - -## License -This project is licensed under either of the following licenses, at your option: - - Apache License, Version 2.0 - - MIT License +telers/README.md \ No newline at end of file diff --git a/telers/README.md b/telers/README.md new file mode 100644 index 0000000..f94ef16 --- /dev/null +++ b/telers/README.md @@ -0,0 +1,67 @@ +
+ +

telers

+ + + + + + + + + + + +

+An asynchronous framework for Telegram Bot API written in Rust +

+ +
+ +

+ +Telers make it easy to create Telegram bots in Rust. + +Before you start, make sure that you have a basic understanding of the [Telegram Bot API](https://core.telegram.org/bots/api), because types and methods in the library have the same fields and types as in the documentation. + +## Highlights + - **Asynchronous**. Built on top of [Tokio](https://tokio.rs/), a powerful asynchronous runtime. + - **Easy to use**. Provides a simple and intuitive API for creating bots. + - **Based on** [aiogram](https://github.com/aiogram/aiogram/). Inspired by the framework written in Python and tries to provide a similar functionality. + - **Routers**, **Middlewares**, **Filters** and **Handlers**. Provides a powerful system of routers, middlewares, filters and handlers to make your code more readable and maintainable, and simplify the creation of bots. + - **Extractors**. Have similar system of extractors as in [axum](https://docs.rs/axum/latest/axum/extract/) and [actix](https://actix.rs/docs/extractors/). + +## Examples + - [Echo bot][examples/echo_bot]. This example shows how to create an echo bot. + - [Text formatting][examples/text_formatting]. This example shows how to format text. + - [Text case filters][examples/text_case_filters]. This example shows how to create text case filters. + - [Stats updates middleware][examples/stats_incoming_updates_middleware]. This example shows how to create a middleware that count incoming updates. + - [Context][examples/from_event_and_context]. This example shows how to extract data from event and context and use it in handlers. + - [Input file][examples/input_file]. This example shows how to send files by the bot. + - [Finite state machine][examples/finite_state_machine]. This example shows how to use a finite state machine (conversation). + - [Router tree][examples/router_tree]. This example shows how to create a router tree. + - [Bot http client][examples/bot_http_client]. This example shows how to set a custom bot HTTP client. + - [Axum and echo bot][examples/axum_and_echo_bot]. This example shows how to create an echo bot and run it concurrently with polling `axum` server. + +You may consider checking out [this directory][examples] for more examples. + +## Community +### Telegram +- 🇺🇸 [@telers_en](https://t.me/telers_en) + +## License +This project is licensed under either of the following licenses, at your option: + - Apache License, Version 2.0 + - MIT License + +[examples]: https://github.com/Desiders/telers/tree/dev-1.x/examples +[examples/axum_and_echo_bot]: https://github.com/Desiders/telers/tree/dev-1.x/examples/axum_and_echo_bot +[examples/bot_http_client]: https://github.com/Desiders/telers/tree/dev-1.x/examples/bot_http_client +[examples/router_tree]: https://github.com/Desiders/telers/tree/dev-1.x/examples/router_tree +[examples/finite_state_machine]: https://github.com/Desiders/telers/tree/dev-1.x/examples/finite_state_machine +[examples/input_file]: https://github.com/Desiders/telers/tree/dev-1.x/examples/input_file +[examples/from_event_and_context]: https://github.com/Desiders/telers/tree/dev-1.x/examples/from_event_and_context +[examples/stats_incoming_updates_middleware]: https://github.com/Desiders/telers/tree/dev-1.x/examples/stats_incoming_updates_middleware +[examples/text_case_filters]: https://github.com/Desiders/telers/tree/dev-1.x/examples/text_case_filters +[examples/text_formatting]: https://github.com/Desiders/telers/tree/dev-1.x/examples/text_formatting +[examples/echo_bot]: https://github.com/Desiders/telers/tree/dev-1.x/examples/echo_bot \ No newline at end of file