Merge branch 'master' of https://gitlab.com/Mishio595/disml into dev

2 files changed, 46 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..4ec75ba
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Adelyn Breedlove
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08e988e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# 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
+* Rudimentary 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
+
+## 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