From 4bfb554f98dbeef2f7238243833c21bac251ef77 Mon Sep 17 00:00:00 2001 From: Adelyn Breedlove Date: Mon, 19 Nov 2018 20:28:57 +0000 Subject: Add README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff4b177 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Dis.ml - An OCaml wrapper for the Discord API + +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. + +#### What is implemented? +* The full Discord REST API +* Redimentary gateway support +* Automatic sharding +* Event dispatch to a user-defined consumer + +#### What is not implemented? +* Abstractions for Discord Objects (Message, Guild, Channel, etc) +* Automatic reconnection of dropped gateway connections +* Voice +* Cache \ No newline at end of file -- cgit v1.2.3