aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoracdenisSK <[email protected]>2017-06-28 19:50:08 +0200
committeracdenisSK <[email protected]>2017-06-28 19:50:08 +0200
commitfdfd5bcf708b6633b564fc58fb86935536310314 (patch)
tree9856e833602662e791aaea8601331001ce91295a /README.md
parentMerge branch "trait-based-event-handling" (diff)
downloadserenity-fdfd5bcf708b6633b564fc58fb86935536310314.tar.xz
serenity-fdfd5bcf708b6633b564fc58fb86935536310314.zip
Update readme, docs and add `EventHandler` to the prelude
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index a4783ec..05e1b7c 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ You may also check your tokens prior to login via the use of
[`validate_token`].
Once logged in, you may add handlers to your client to dispatch [`Event`]s,
-such as [`Client::on_message`]. This will cause your handler to be called
+by implementing the handlers in a trait, such as [`EventHandler::on_message`]. This will cause your handler to be called
when a [`Event::MessageCreate`] is received. Each handler is given a
[`Context`], giving information about the event. See the
[client's module-level documentation].
@@ -138,7 +138,7 @@ Voice+youtube-dl:
[`Cache`]: https://docs.rs/serenity/*/serenity/cache/struct.Cache.html
[`Client::new`]: https://docs.rs/serenity/*/serenity/client/struct.Client.html#method.new
-[`Client::on_message`]: https://docs.rs/serenity/*/serenity/client/struct.Client.html#method.on_message
+[`EventHandler::on_message`]: https://docs.rs/serenity/*/serenity/client/struct.EventHandler.html#method.on_message
[`Context`]: https://docs.rs/serenity/*/serenity/client/struct.Context.html
[`Event`]: https://docs.rs/serenity/*/serenity/model/event/enum.Event.html
[`Event::MessageCreate`]: https://docs.rs/serenity/*/serenity/model/event/enum.Event.html#variant.MessageCreatef