https://github.com/matiaslina/matrix-client

Matrix client for Raku
https://github.com/matiaslina/matrix-client

matrix raku

Last synced: 3 months ago
JSON representation

Matrix client for Raku

• Host: GitHub
• URL: https://github.com/matiaslina/matrix-client
• Owner: matiaslina
• License: artistic-2.0
• Created: 2017-04-04T01:15:20.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-25T23:52:58.000Z (over 3 years ago)
• Last Synced: 2024-10-10T20:41:49.667Z (3 months ago)
• Topics: matrix, raku
• Language: Raku
• Homepage:
• Size: 144 KB
• Stars: 13
• Watchers: 4
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Matrix::Client

A [Raku](https://raku.org) library for [Matrix](https://matrix.org).

## Installation

    zef install Matrix::Client

## Usage

    use Matrix::Client;

    my $client = Matrix::Client.new(

        :home-server,

        :device-id

    );

    $client.login(:username, :password);

    # Check my user

    say $client.whoami;  # @myuser:matrix.org

    # Send a message to a random room that I'm in

    my $room = $client.joined-rooms.pick;

    say "Sending a message to {$room.name}";

    $room.send("Hello from Raku!");

## Description

Matrix is an open network for secure, decentralized communication.

This module provides an interface to interact with a Matrix homeserver through

the *Client-Server API*. It's currenlty on active development but it's mostly

stable for day to day use.

Here's a not complete list of things that can be done:

* Login/logout

* Registration

* Synchronization of events/messages

* Send events

* Send messages

* Upload files to a home-server

There are many missing endpoints (you can check a complete checklist

[here](https://github.com/matiaslina/perl6-matrix-client/blob/master/endpoints.md)).

If you want to contribute with some endpoint check the

[CONTRIBUTING.md](CONTRIBUTING.md) file.

## Documentation

There's a couple of pages of documentation on the `docs/` directory. This

includes API documentation, basic usage, examples, etc.

## Author

Matías Linares  | Matrix ID: `@matias:chat.deprecated.org`