From bae9af0cd015880a48e1587eb49adc014cae5d5a Mon Sep 17 00:00:00 2001 From: Matias Linares Date: Tue, 4 Apr 2017 20:23:27 -0300 Subject: Add readme --- README.md | 23 +++++++++++++++++++++++ examples/rooms.p6 | 1 + 2 files changed, 24 insertions(+) create mode 100644 README.md 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 +# 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; -- cgit v1.2.3-54-g00ecf