summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHubert Chathi <hubert@uhoreg.ca>2019-09-23 21:38:04 -0400
committerHubert Chathi <hubert@uhoreg.ca>2019-09-23 21:38:04 -0400
commit6eca595c48cf2a7acddb992e96245a4bbcf06e36 (patch)
tree2f9d766ffa0236058b6b4c49924b2e987c517411 /README.md
initial version, extracted from Igor
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c75e058
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Polyjuice Client
+
+Polyjuice Client is a [Matrix](https://matrix.org/) client library.
+
+## Installation
+
+The package can be installed by adding `polyjuice_client` to your list of
+dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:polyjuice_client, "~> 0.1.0"}
+ ]
+end
+```