From 37617baeb89ca53157a96a7bd4d95317b3a2a552 Mon Sep 17 00:00:00 2001 From: Adelyn Breedlove Date: Mon, 19 Nov 2018 20:34:00 +0000 Subject: Update README.md --- README.md | 11 +++++++++-- 1 file 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 -- cgit v1.2.3