From 0b1e90f84b94e22fc8d5a1eb6158498a1a5b2f17 Mon Sep 17 00:00:00 2001 From: Matias Linares Date: Tue, 4 Jun 2019 23:04:43 -0300 Subject: Update readme --- .gitignore | 1 + META6.json | 63 +++++++++++++++++++++++++++++++++++--------------------------- README.md | 41 +++++++++++++++++++++++----------------- 3 files changed, 61 insertions(+), 44 deletions(-) diff --git a/.gitignore b/.gitignore index 0e5e830..0d701e8 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ state file.json .precomp **/*/.precomp +todo.org \ No newline at end of file diff --git a/META6.json b/META6.json index 83455e5..0788805 100644 --- a/META6.json +++ b/META6.json @@ -1,29 +1,38 @@ { - "perl" : "6.c", - "name" : "Matrix::Client", - "license" : "Artistic-2.0", - "version" : "0.3.0", - "description" : "Matrix client for Perl 6", - "tags" : [ "Net", "Matrix" ], - "depends" : [ - "JSON::Tiny", - "HTTP::UserAgent", - "URI::Encode", - "IO::Socket::SSL" - ], - "test-depends" : [ - "Test", - "Test::META" - ], - "provides" : { - "Matrix::Client" : "lib/Matrix/Client.pm6", - "Matrix::Response" : "lib/Matrix/Response.pm6", - "Matrix::Client::Room" : "lib/Matrix/Client/Room.pm6", - "Matrix::Client::Requester" : "lib/Matrix/Client/Requester.pm6", - "Matrix::Client::Common" : "lib/Matrix/Client/Common.pm6", - "Matrix::Client::Exception" : "lib/Matrix/Client/Exception.pm6" - }, - "authors" : ["Matias Linares"], - "support" : {"source" : "git://github.com/matiaslina/perl6-matrix-client.git"}, - "source-url" : "https://github.com/matiaslina/perl6-matrix-client.git" + "authors" : [ + "Matias Linares" + ], + "build-depends" : [ ], + "depends" : [ + "JSON::Tiny", + "HTTP::UserAgent", + "URI::Encode", + "IO::Socket::SSL" + ], + "description" : "Matrix client for Perl 6", + "license" : "Artistic-2.0", + "name" : "Matrix::Client", + "perl" : "6.c", + "provides" : { + "Matrix::Client" : "lib/Matrix/Client.pm6", + "Matrix::Client::Common" : "lib/Matrix/Client/Common.pm6", + "Matrix::Client::Exception" : "lib/Matrix/Client/Exception.pm6", + "Matrix::Client::Requester" : "lib/Matrix/Client/Requester.pm6", + "Matrix::Client::Room" : "lib/Matrix/Client/Room.pm6", + "Matrix::Response" : "lib/Matrix/Response.pm6" + }, + "resources" : [ ], + "source-url" : "https://github.com/matiaslina/perl6-matrix-client.git", + "support" : { + "source" : "git://github.com/matiaslina/perl6-matrix-client.git" + }, + "tags" : [ + "Net", + "Matrix" + ], + "test-depends" : [ + "Test", + "Test::META" + ], + "version" : "0.3.0" } diff --git a/README.md b/README.md index 43c1aac..e629915 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ -# Matrix client +### multi method tags -A perl 6 library for [Matrix](https://matrix.org). +```perl6 +multi method tags( + Str $room-id, + Str:D $tag, + $order +) returns Mu +``` -## Status +PUT - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag} -This project is in early development. A lot of methods return a raw -`HTTP::Response` and not something from this library. +### multi method tags -## Examples +```perl6 +multi method tags( + Str $room-id +) returns Mu +``` -From the `examples` directory: +GET - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags - use v6; - use Matrix::Client; +### method remove-tag - # Instantiate a new client for a given home-server - my $client = Matrix::Client.new: :home-server - # Login - $client.login: @*ARGS[0], @*ARGS[1]; +```perl6 +method remove-tag( + Str $room-id, + Str:D $tag +) returns Mu +``` - # Show all joined rooms - say $client.rooms(:sync); +DELETE - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag} - # And finally logout. - $client.logout -- cgit v1.2.3-54-g00ecf