sch/JabberCard
1
0
Fork 0
Code Issues 14 Pull requests Projects Releases Packages Wiki Activity Actions

Update document README.md

Browse source
This commit is contained in:
Schimon Jehudah, Adv. 2024-11-05 11:21:19 +02:00
parent cbcf3b58d0
commit bd66df88d3
1 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -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 ## 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 The main purpose, is to provide an interface to share XMPP contacts via HTML
browsers. browsers.
It also provides an interface to explore XMPP server conferences, pubsub and It also provides an interface to explore XMPP server conferences, pubsub and
other services. 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; - Add interactive capabilities, as well as vCard information;
- Create rapport with the viewers, by displaying vCard information, such as Full - 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 ## 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 ## Supported features
@ -69,16 +70,16 @@ FASI require an XMPP account to work, it only needs an XMPP server.
- XEP-0030: Service Discovery - XEP-0030: Service Discovery
- XEP-0045: Multi-User Chat - XEP-0045: Multi-User Chat
- XEP-0054: vcard-temp
- XEP-0060: Publish-Subscribe - XEP-0060: Publish-Subscribe
- XEP-0292: vCard4 Over XMPP
## Install ## Install
Use the following commands, to begin FASI. Use the following commands, to begin JabberCard.
```shell ```shell
git clone https://git.xmpp-it.net/sch/FASI git clone https://git.xmpp-it.net/sch/JabberCard
cd FASI/ cd JabberCard/
python -m uvicorn fasi:app python -m uvicorn fasi:app
``` ```
@ -90,6 +91,13 @@ AGPL-3.0-only
Schimon Jehudah Zachary 2024 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 ## Thanks
A special thank you for Mr. Georg Lukas of [op-co.de](https://op-co.de/) from A special thank you for Mr. Georg Lukas of [op-co.de](https://op-co.de/) from