summaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorPaul Schoenfelder <paulschoenfelder@gmail.com>2016-02-27 21:59:42 -0600
committerPaul Schoenfelder <paulschoenfelder@gmail.com>2016-02-27 21:59:42 -0600
commit17c2b56ed9565cb05f72d7a6ff212027da24d2a9 (patch)
treebb39a6215c3e1dc41dd863e0ada88d21d60c8933 /examples/README.md
parentAdd earmark dep for ex_doc (diff)
Add new example. Closes #38
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..d51b9a2
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,7 @@
+## Example Bot
+
+Add bot configuration or change pre-existing one in `config/config.exs`
+
+Run using `mix run --no-halt` or `iex -S mix`, some basic info will be output to the console.
+
+Default app connects to a random room on Freenode, should just work out of the box.