aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdelyn Breelove <[email protected]>2019-01-30 13:46:57 -0700
committerAdelyn Breelove <[email protected]>2019-01-30 13:46:57 -0700
commitb9271177e7e363bbb0424bfb2aee26d913198e96 (patch)
tree812bcf7174035c8de1151c8425d5bc4a20510007 /README.md
parenthotfix to writing on a closed pipe (diff)
downloaddisml-b9271177e7e363bbb0424bfb2aee26d913198e96.tar.xz
disml-b9271177e7e363bbb0424bfb2aee26d913198e96.zip
Update README (again)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index b930273..e151d5d 100644
--- a/README.md
+++ b/README.md
@@ -23,11 +23,22 @@ Latest changes are on master
## 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 manager and build tool respectively.
-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.
+The project is not currently uploaded to opam, but you can still install via opam by pinning to this repo.
+
+```
+opam pin add disml https://gitlab.com/Mishio595/disml.git
+```
+
+If you do not use opam, see `disml.opam` for build instructions.
You'll find an example bot in /bin directory.
-### Barebones example
+### Examples
+
+##### Robust example
+`/bin/bot.ml`
+
+##### Basic example
```ocaml
open Async