aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdelyn Breedlove <[email protected]>2018-11-19 20:34:11 +0000
committerAdelyn Breedlove <[email protected]>2018-11-19 20:34:11 +0000
commit274123e4bcf6ba13461ca36c0426554858c088eb (patch)
tree9fbc9505954badbf497ae510fdd8f2614ab733df
parentMerge branch 'patch-1' into 'master' (diff)
parentUpdate README.md (diff)
downloaddisml-274123e4bcf6ba13461ca36c0426554858c088eb.tar.xz
disml-274123e4bcf6ba13461ca36c0426554858c088eb.zip
Merge branch 'patch-1' into 'master'
Update README.md See merge request Mishio595/disml!9
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index ff4b177..08e988e 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ This is being actively developed and is definitely still in the early stages. Wh
#### What is implemented?
* The full Discord REST API
-* Redimentary gateway support
+* Rudimentary gateway support
* Automatic sharding
* Event dispatch to a user-defined consumer
@@ -15,4 +15,11 @@ This is being actively developed and is definitely still in the early stages. Wh
* Abstractions for Discord Objects (Message, Guild, Channel, etc)
* Automatic reconnection of dropped gateway connections
* Voice
-* Cache \ No newline at end of file
+* Cache
+
+## Getting started
+In order to get started you'll first need to install OCaml (of course). I recommend using OPAM and Dune as a package manage and build tool respectively.
+
+I currently don't provide an opam build file nor is the project uploaded to opam. This will happen with the first stable release.
+
+You'll find an example bot in /bin directory. \ No newline at end of file