From 413688970949ee4a7efdfb56c758ac1bece61fb6 Mon Sep 17 00:00:00 2001 From: sunglocto <76428041+sunglocto@users.noreply.github.com> Date: Tue, 5 Aug 2025 09:16:48 +0000 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c1d361a..1ccc1e1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # π [![Go](https://github.com/sunglocto/pi/actions/workflows/go.yml/badge.svg)](https://github.com/sunglocto/pi/actions/workflows/go.yml) - +## the XMPP client from hell Experimental and extremely weird XMPP client made with Go. No solicitors. @@ -18,22 +18,35 @@ pi is an extremely opinionated client. It aims to have as little extra windows a ## διαμόρφωση (configuration) -In order to use pi, you currently have to create a `pi.json` file in the working directory of the executable. Here is how one looks like: +In order to use pi, you currently have to create a `pi.json` file in the working directory of the executable. Here is how one looks like as of time of writing: ```json { - "Host":"example.com:5222", - "User":"user@example.com", - "Password":"123456", - "DisplayName":"user", - "NoTLS":false, - "StartTLS":true, - "Mucs":["room@muc.example.com"] + "Login": { + "Host": "example.com:5222", + "User": "user@example.com", + "Password": "123456", + "DisplayName": "user", + "NoTLS": false, + "StartTLS": true, + "Mucs": [ + "room1@group.example.com", + "room2@group.example.com" + ] + }, + "DMs": [ + "mike@example.com", + "louis@example.com" + ], + "Notifications": false } ``` Edit this file as necessary. +A login screen will be implemented in pi 3.1a. + + Currently joining and saving DM tabs is not supported, nor is getting avatars, reactions, encryption of media embed. As of writing, pi supports basic message sending and receiving, replies and file upload.