aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatias Linares <matiaslina@openmailbox.org>2017-04-04 20:23:27 -0300
committerMatias Linares <matiaslina@openmailbox.org>2017-04-04 20:23:27 -0300
commitbae9af0cd015880a48e1587eb49adc014cae5d5a (patch)
treec63bd9cc8c7132f667ecee0176a6a6ec928af07d
parent9c439e653e19472c242fc0bff10e31a57b1ea45f (diff)
downloadperl6-matrix-client-bae9af0cd015880a48e1587eb49adc014cae5d5a.tar.gz
Add readme
-rw-r--r--README.md23
-rw-r--r--examples/rooms.p61
2 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37faf20
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Matrix client
+
+Simple [matrix](https://matrix.org) client.
+
+# Examples
+
+From the `examples` directory
+
+```
+use v6;
+use Matrix::Client;
+
+# Instantiate a new client for a given home-server
+my $client = Matrix::Client.new: :home-server<https://matrix.org>
+# Login
+$client.login: @*ARGS[0], @*ARGS[1];
+
+# Show all joined rooms
+say $client.rooms;
+
+# And finally logout.
+$client.logout
+```
diff --git a/examples/rooms.p6 b/examples/rooms.p6
index 7f62233..6af04bc 100644
--- a/examples/rooms.p6
+++ b/examples/rooms.p6
@@ -1,3 +1,4 @@
+use v6;
use Matrix::Client;
my $c = Matrix::Client.new: :home-server<https://matrix.deprecated.org>;