Use consistent naming of our crates

Former-commit-id: 1ab5bdfc77
This commit is contained in:
Hirrolot 2022-10-07 16:34:42 +06:00
parent cbd8978e65
commit 01f0818e94
8 changed files with 17 additions and 16 deletions

View file

@ -60,7 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add the `Key: Clone` requirement for `impl Dispatcher` [**BC**]. - Add the `Key: Clone` requirement for `impl Dispatcher` [**BC**].
- `dispatching::update_listeners::{polling_default, polling}` now return a named, `Polling<_>` type. - `dispatching::update_listeners::{polling_default, polling}` now return a named, `Polling<_>` type.
- Update teloxide-core to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more information [**BC**]. - Update `teloxide-core` to v0.7.0 with Bot API 6.1 support, see [its changelog][core07c] for more information [**BC**].
[core07c]: https://github.com/teloxide/teloxide-core/blob/master/CHANGELOG.md#070---2022-07-19 [core07c]: https://github.com/teloxide/teloxide-core/blob/master/CHANGELOG.md#070---2022-07-19
@ -90,7 +90,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed ### Changed
- Update teloxide-core to v0.6.0 with [Bot API 6.0] support [**BC**]. - Update `teloxide-core` to v0.6.0 with [Bot API 6.0] support [**BC**].
[Bot API 6.0]: https://core.telegram.org/bots/api#april-16-2022 [Bot API 6.0]: https://core.telegram.org/bots/api#april-16-2022

View file

@ -83,6 +83,7 @@ impl<T: Trait> Trait for Wrap<T> { ... }
/// [`tokio::fs::File`]: tokio::fs::File /// [`tokio::fs::File`]: tokio::fs::File
/// [`Bot::download_file`]: crate::Bot::download_file /// [`Bot::download_file`]: crate::Bot::download_file
``` ```
4. Write `teloxide`, `teloxide-macros`, and `teloxide-core`, not "teloxide", "Teloxide", "teloxide-macros" or any other variant.
## Use `Self` where possible ## Use `Self` where possible

View file

@ -2,7 +2,7 @@
<div align="center"> <div align="center">
<img src="./ICON.png" width="250"/> <img src="./ICON.png" width="250"/>
<h1>teloxide</h1> <h1>`teloxide`</h1>
<a href="https://docs.rs/teloxide/"> <a href="https://docs.rs/teloxide/">
<img src="https://docs.rs/teloxide/badge.svg"> <img src="https://docs.rs/teloxide/badge.svg">
</a> </a>
@ -24,7 +24,7 @@
## Highlights ## Highlights
- **Declarative design.** teloxide is based upon [`dptree`], a functional [chain of responsibility] pattern that allows you to express pipelines of message processing in a highly declarative and extensible style. - **Declarative design.** `teloxide` is based upon [`dptree`], a functional [chain of responsibility] pattern that allows you to express pipelines of message processing in a highly declarative and extensible style.
[`dptree`]: https://github.com/teloxide/dptree [`dptree`]: https://github.com/teloxide/dptree
[chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern [chain of responsibility]: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern
@ -56,7 +56,7 @@ $ set TELOXIDE_TOKEN=<Your token here>
$ $env:TELOXIDE_TOKEN=<Your token here> $ $env:TELOXIDE_TOKEN=<Your token here>
``` ```
4. Make sure that your Rust compiler is up to date (teloxide currently requires rustc at least version 1.58): 4. Make sure that your Rust compiler is up to date (`teloxide` currently requires rustc at least version 1.58):
```bash ```bash
# If you're using stable # If you're using stable
$ rustup update stable $ rustup update stable
@ -304,7 +304,7 @@ A: No, only the bots API.
**Q: Can I use webhooks?** **Q: Can I use webhooks?**
A: You can! Teloxide has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs). A: You can! `teloxide` has a built-in support for webhooks in `dispatching::update_listeners::webhooks` module. See how it's used in [`examples/ngrok_ping_pong_bot`](examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](examples/heroku_ping_pong.rs).
**Q: Can I handle both callback queries and messages within a single dialogue?** **Q: Can I handle both callback queries and messages within a single dialogue?**
@ -328,7 +328,7 @@ Feel free to propose your own bot to our collection!
- [`zamazan4ik/npaperbot-telegram`](https://github.com/zamazan4ik/npaperbot-telegram) — Telegram bot for searching via C++ proposals. - [`zamazan4ik/npaperbot-telegram`](https://github.com/zamazan4ik/npaperbot-telegram) — Telegram bot for searching via C++ proposals.
<details> <details>
<summary>Show bots using teloxide older than v0.6.0</summary> <summary>Show bots using `teloxide` older than v0.6.0</summary>
- [`mxseev/logram`](https://github.com/mxseev/logram) — Utility that takes logs from anywhere and sends them to Telegram. - [`mxseev/logram`](https://github.com/mxseev/logram) — Utility that takes logs from anywhere and sends them to Telegram.
- [`alexkonovalov/PedigreeBot`](https://github.com/alexkonovalov/PedigreeBot) — A Telegram bot for building family trees. - [`alexkonovalov/PedigreeBot`](https://github.com/alexkonovalov/PedigreeBot) — A Telegram bot for building family trees.
@ -340,7 +340,7 @@ Feel free to propose your own bot to our collection!
</details> </details>
See [700+ other public repositories using teloxide >>](https://github.com/teloxide/teloxide/network/dependents) See [700+ other public repositories using `teloxide` >>](https://github.com/teloxide/teloxide/network/dependents)
## Contributing ## Contributing

View file

@ -37,7 +37,7 @@ use std::{fmt::Debug, marker::PhantomData};
/// ///
/// ## Handler arguments /// ## Handler arguments
/// ///
/// Teloxide provides the following types to the `handler`: /// `teloxide` provides the following types to the `handler`:
/// - [`Message`] /// - [`Message`]
/// - `R` (type of the `bot`) /// - `R` (type of the `bot`)
/// - `Cmd` (type of the parsed command) /// - `Cmd` (type of the parsed command)
@ -105,7 +105,7 @@ where
/// ///
/// ## Handler arguments /// ## Handler arguments
/// ///
/// Teloxide provides the following types to the `handler`: /// `teloxide` provides the following types to the `handler`:
/// - [`Message`] /// - [`Message`]
/// - `R` (type of the `bot`) /// - `R` (type of the `bot`)
/// - `Cmd` (type of the parsed command) /// - `Cmd` (type of the parsed command)

View file

@ -27,7 +27,7 @@ use std::fmt::Debug;
/// ///
/// ## Handler arguments /// ## Handler arguments
/// ///
/// Teloxide provides the following types to the `handler`: /// `teloxide` provides the following types to the `handler`:
/// - [`Message`] /// - [`Message`]
/// - `R` (type of the `bot`) /// - `R` (type of the `bot`)
/// - [`Me`] /// - [`Me`]
@ -81,7 +81,7 @@ where
/// ///
/// ## Handler arguments /// ## Handler arguments
/// ///
/// Teloxide provides the following types to the `handler`: /// `teloxide` provides the following types to the `handler`:
/// - [`Message`] /// - [`Message`]
/// - `R` (type of the `bot`) /// - `R` (type of the `bot`)
/// - [`Me`] /// - [`Me`]

View file

@ -67,7 +67,7 @@ where
/// ///
/// ## Note /// ## Note
/// ///
/// Teloxide normally (when using [`Dispatcher`] or [`repl`]s) sets this /// `teloxide` normally (when using [`Dispatcher`] or [`repl`]s) sets this
/// automatically via [`hint_allowed_updates`], so you rarely need to use /// automatically via [`hint_allowed_updates`], so you rarely need to use
/// `allowed_updates` explicitly. /// `allowed_updates` explicitly.
/// ///

View file

@ -49,7 +49,7 @@ pub struct Options {
/// `a-z`, `0-9`, `_` and `-` are allowed. The header is useful to ensure /// `a-z`, `0-9`, `_` and `-` are allowed. The header is useful to ensure
/// that the request comes from a webhook set by you. /// that the request comes from a webhook set by you.
/// ///
/// Default - teloxide will generate a random token. /// Default - `teloxide` will generate a random token.
pub secret_token: Option<String>, pub secret_token: Option<String>,
} }

View file

@ -12,7 +12,7 @@
| `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. | | `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. |
| `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. | | `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. |
| `full` | Enables all the features except `nightly`. | | `full` | Enables all the features except `nightly`. |
| `nightly` | Enables nightly-only features (see the [teloxide-core features]). | | `nightly` | Enables nightly-only features (see the [`teloxide-core` features]). |
| `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). | | `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). |
| `rustls` | Enables the [`rustls`] TLS implementation. | | `rustls` | Enables the [`rustls`] TLS implementation. |
| `redis-storage` | Enables the [Redis] storage support for dialogues. | | `redis-storage` | Enables the [Redis] storage support for dialogues. |
@ -29,6 +29,6 @@
[`native-tls`]: https://docs.rs/native-tls [`native-tls`]: https://docs.rs/native-tls
[`rustls`]: https://docs.rs/rustls [`rustls`]: https://docs.rs/rustls
[`teloxide::utils::UpState`]: utils::UpState [`teloxide::utils::UpState`]: utils::UpState
[teloxide-core features]: https://docs.rs/teloxide-core/latest/teloxide_core/#cargo-features [`teloxide-core` features]: https://docs.rs/teloxide-core/latest/teloxide_core/#cargo-features
[`DispatcherBuilder::enable_ctrlc_handler`]: dispatching::DispatcherBuilder::enable_ctrlc_handler [`DispatcherBuilder::enable_ctrlc_handler`]: dispatching::DispatcherBuilder::enable_ctrlc_handler