From bd66df88d34ec7f6da26320e7ecef879551ef593 Mon Sep 17 00:00:00 2001 From: "Schimon Jehudah, Adv." Date: Tue, 5 Nov 2024 11:21:19 +0200 Subject: [PATCH] Update document README.md --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ffa99b4..5c8f090 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ -# FASI +# JabberCard -Fast And Sleek Invite (FASI) +JabberCard (formerly FASI) is a "fancy and sleek invitation" system with +addeitional features. https://schapps.woodpeckersnest.eu/jabbercard/ ## About -FASI is an HTML invite page for XMPP. +JabberCard is an HTML invite page for XMPP. The main purpose, is to provide an interface to share XMPP contacts via HTML browsers. It also provides an interface to explore XMPP server conferences, pubsub and other services. -### Reasons for creating FASI +### Reasons for creating JabberCard -The main reasons for the realization of FASI are to: +The main reasons for the realization of JabberCard are to: - Add interactive capabilities, as well as vCard information; - Create rapport with the viewers, by displaying vCard information, such as Full @@ -52,9 +53,9 @@ The main reasons for the realization of FASI are to: ## Technicalities -FASI is written in Python and utilizes Jinja2, FastAPI and Slixmpp. +JabberCard is written in Python and utilizes Jinja2, FastAPI and Slixmpp. -FASI require an XMPP account to work, it only needs an XMPP server. +JabberCard requires an XMPP account to work, it only needs an XMPP server. ## Supported features @@ -69,16 +70,16 @@ FASI require an XMPP account to work, it only needs an XMPP server. - XEP-0030: Service Discovery - XEP-0045: Multi-User Chat -- XEP-0054: vcard-temp - XEP-0060: Publish-Subscribe +- XEP-0292: vCard4 Over XMPP ## Install -Use the following commands, to begin FASI. +Use the following commands, to begin JabberCard. ```shell -git clone https://git.xmpp-it.net/sch/FASI -cd FASI/ +git clone https://git.xmpp-it.net/sch/JabberCard +cd JabberCard/ python -m uvicorn fasi:app ``` @@ -90,6 +91,13 @@ AGPL-3.0-only Schimon Jehudah Zachary 2024 +## Contributors + +- Mr. Marvin Wißfeld for consulting and supervising the implementation of + XEP-0292: vCard4 Over XMPP + +- Mr. Matija Šuklje for proposing "JabberCard" as the name of this project. + ## Thanks A special thank you for Mr. Georg Lukas of [op-co.de](https://op-co.de/) from