aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/README.md b/README.md
index 02c4078..4b4119f 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,28 @@
-# Thulani
+# thulani
-**TODO: Add description**
+Discord bot that stores / posts random memes and plays audio in voice chat.
-## Installation
+[Formerly written in Rust](https://pub.npry.dev/thulani). <!-- TODO: update branch !-->
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `thulani` to your list of dependencies in `mix.exs`:
+## Installation
```elixir
def deps do
[
- {:thulani, "~> 0.1.0"}
+ {:thulani, "~> 0.1"}
]
end
```
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/thulani>.
+## Configuration
+
+```elixir
+config :thulani,
+ prefix: "!thulani "
+
+# optional: retrieved from DATABASE_URL env var if not configured
+config :thulani, Thulani.Repo, "psql:///user:pass@dbhost/db"
+# optional: retrieved from DISCORD_TOKEN env var if not configured
+config :nostrum, token: "my_discord_token"
+```