From 6b16b0537ed63690dd965a0d0b832a0b0937de96 Mon Sep 17 00:00:00 2001 From: Adelyn Breelove Date: Fri, 21 Dec 2018 09:21:06 -0700 Subject: Update README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7f5cd2a..98208f1 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ This is a library for creating bots on [Discord](https://discordapp.com/). Dis.ml uses JaneStreet's Async and Core libs and I highly recommend having a solid understanding of both of these before using this library. ## State of the project -This is being actively developed and is definitely still in the early stages. While you definitely could create a bot with this in its current state, you would be writing a lot of boilerplate still. +The dev branch is fully capable of creating a simple bot at this point in time. #### What is implemented? * The full Discord REST API -* Rudimentary gateway support +* Complete gateway support (sans voice) * Automatic sharding * Event dispatch to a user-defined consumer * Automatic reconnection of dropped gateway connections @@ -19,8 +19,8 @@ This is being actively developed and is definitely still in the early stages. Wh * 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. +In order to get started you'll first need to install OCaml (of course). I recommend using OPAM and Dune as a package manager 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. +The project is not currently uploaded to opam. This will happen with the first stable release. If you do not use opam, see `disml.opam` for build instructions. You'll find an example bot in /bin directory. -- cgit v1.2.3