aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2018-07-29 19:26:57 -0700
committerZeyla Hellyer <[email protected]>2018-07-29 19:26:57 -0700
commitfede55f1e3d64507f7ca9e18e64e17886e17157a (patch)
treecee0b369e1728f040eeca86ac385a1b4a1441ff1 /README.md
parentAdd note about cache in UserId::get docs (diff)
downloadserenity-fede55f1e3d64507f7ca9e18e64e17886e17157a.tar.xz
serenity-fede55f1e3d64507f7ca9e18e64e17886e17157a.zip
Readme: list default features in "Features"
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index d1417a9..ea2eb64 100644
--- a/README.md
+++ b/README.md
@@ -103,6 +103,9 @@ features = ["pick", "your", "feature", "names", "here"]
version = "0.5"
```
+The default features are: `builder`, `cache`, `client`, `framework`, `gateway`,
+`http`, `model`, `standard_framework`, and `utils`.
+
The following is a full list of features:
- **builder**: The builders used in conjunction with models' methods.
@@ -124,6 +127,24 @@ the HTTP functions.
- **voice**: Enables compilation of voice support, so that voice channels can be
connected to and audio can be sent/received.
+If you want all of the default features except for `cache` for example, you can
+list all but that:
+
+```toml
+[dependencies.serenity]
+default-features = false
+features = [
+ "builder",
+ "client",
+ "framework",
+ "gateway",
+ "http",
+ "model",
+ "standard_framework",
+ "utils",
+]
+version = "0.5"
+
# Dependencies
Serenity requires the following dependencies: