OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2024-12-22 06:25:10 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix teloxide readme

Browse source
This commit is contained in:
Maybe Waffle 2022-11-01 16:50:24 +04:00
parent 10c8a205b1
commit c84fa49600
3 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -85,7 +85,7 @@ tokio = { version = "1.8", features = ["rt-multi-thread", "macros"] }
This bot replies with a die throw to each received message: This bot replies with a die throw to each received message:
[[`examples/throw_dice.rs`](examples/throw_dice.rs)] [[`examples/throw_dice.rs`](crates/teloxide/examples/throw_dice.rs)]
```rust,no_run ```rust,no_run
use teloxide::prelude::*; use teloxide::prelude::*;
@ -120,7 +120,7 @@ Commands are strongly typed and defined declaratively, similar to how we define
[structopt]: https://docs.rs/structopt/0.3.9/structopt/ [structopt]: https://docs.rs/structopt/0.3.9/structopt/
[serde-json]: https://github.com/serde-rs/json [serde-json]: https://github.com/serde-rs/json
[[`examples/command.rs`](examples/command.rs)] [[`examples/command.rs`](crates/teloxide/examples/command.rs)]
```rust,no_run ```rust,no_run
use teloxide::{prelude::*, utils::command::BotCommands}; use teloxide::{prelude::*, utils::command::BotCommands};
@ -174,7 +174,7 @@ A dialogue is typically described by an enumeration where each variant is one po
Below is a bot that asks you three questions and then sends the answers back to you: Below is a bot that asks you three questions and then sends the answers back to you:
[[`examples/dialogue.rs`](examples/dialogue.rs)] [[`examples/dialogue.rs`](crates/teloxide/examples/dialogue.rs)]
```rust,ignore ```rust,ignore
use teloxide::{dispatching::dialogue::InMemStorage, prelude::*}; use teloxide::{dispatching::dialogue::InMemStorage, prelude::*};
@ -285,7 +285,7 @@ async fn receive_location(
<img src="./media/dialogue.gif" width="420" /> <img src="./media/dialogue.gif" width="420" />
</div> </div>
[More examples >>](examples/) [More examples >>](crates/teloxide/examples/)
## FAQ ## FAQ
@ -307,11 +307,11 @@ 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`](crates/teloxide/examples/ngrok_ping_pong.rs) and [`examples/heroku_ping_pong_bot`](crates/teloxide/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?**
A: Yes, see [`examples/purchase.rs`](examples/purchase.rs). A: Yes, see [`examples/purchase.rs`](crates/teloxide/examples/purchase.rs).
## Community bots ## Community bots

3
crates/teloxide/README.md Normal file
View file

@ -0,0 +1,3 @@
See [`README.md`] at the root of the repository.
[`README.md`]: ../../README.md

2
crates/teloxide/src/lib.rs
View file

@ -79,7 +79,7 @@ pub use dispatching::filter_command;
pub use dptree::{self, case as handler}; pub use dptree::{self, case as handler};
#[cfg(all(feature = "nightly", doctest))] #[cfg(all(feature = "nightly", doctest))]
#[cfg_attr(feature = "nightly", cfg_attr(feature = "nightly", doc = include_str!("../README.md")))] #[cfg_attr(feature = "nightly", cfg_attr(feature = "nightly", doc = include_str!("../../README.md")))]
enum ReadmeDocTests {} enum ReadmeDocTests {}
use teloxide_core::requests::ResponseResult; use teloxide_core::requests::ResponseResult;