aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAustin Hellyer <[email protected]>2016-12-08 21:37:44 -0800
committerAustin Hellyer <[email protected]>2016-12-09 16:10:37 -0800
commita43b468dc16597ced720f4b5111a0fc9625db113 (patch)
tree2682d48166fe33b7a8fafef7bea366a89ddd6982 /README.md
parentFix some clippy lints (diff)
downloadserenity-a43b468dc16597ced720f4b5111a0fc9625db113.tar.xz
serenity-a43b468dc16597ced720f4b5111a0fc9625db113.zip
Add installation notes
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index f3778a0..3714dcb 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,23 @@ fn ping(_context: &Context, message: &Message, _args: Vec<String>) {
Full examples, detailing and explaining usage of the basic functionality of the
library, can be found in the [`examples`] directory.
+# Installation
+
+Add the following to your `Cargo.toml` file:
+
+```toml
+[dependencies]
+serenity = "0.1"
+```
+
+and to the top of your `main.rs`:
+
+```rs
+#[macro_use] extern crate serenity;
+```
+
+Serenity only supports the _latest_ Stable, Beta, and Nightly.
+
# Features
Features can be enabled or disabled by configuring the library through