Add a background graphic;

Add more information to the file README.
This commit is contained in:
Schimon Jehudah, Adv. 2024-10-08 15:20:29 +03:00
parent 95c1f30ebc
commit 0d2e55fa14
2 changed files with 97 additions and 1 deletions

View file

@ -10,16 +10,62 @@ browsers.
It also provides an interface to explore XMPP server conferences, pubsub and
other services.
### Reasons for creating of FASI
The main reasons for the realization of FASI are:
- Add interactive capabilities, as well as vCard information;
- Create rapport with the viewers, by displaying vCard information, such as Full
Name and Description or Note;
- Charm our "normie" friends, so called, by displaying an attractive contact
HTML page, which they can also utilize;
- Utilize an invitation page, with XMPP capabilities, regardless to the software
that powers an XMPP server;
- Realize that HTTP is obsolete and should be treated as an optional publishing
mean, because anything that HTTP offers, is already possible with XMPP, since
a couple of decades ago.
### Special features
- Fetch vCards and photos;
- Indicate of available conferences, nodes and services;
- Retrieve number of conferences, nodes, participants, node items and services;
- Preview recent conference messages;
- View journal articles (i.e. PubSub node items that are published as Atom Over
XMPP).
### Byproduct
- Browse services;
- Explore JID and node items.
### Other features
- Customization for specific brands (e.g. monocles chat);
- Dynamic background in accordance to the photo colors.
## Technicalities
FASI is written in Python and utilizes Jinja2, FastAPI and Slixmpp.
FASI require an XMPP account to work, it only needs an XMPP server.
## Features
- MUC
- Photo
- PubSub
- QR code
- Service discovery
- Service Discovery
- vCard
## XEP
- XEP-0030: Service Discovery
- XEP-0045: Multi-User Chat
- XEP-0054: vcard-temp
- XEP-0060: Publish-Subscribe
## Install
Use the following commands, to begin FASI.
@ -37,3 +83,8 @@ AGPL-3.0-only
## Copyright
Schimon Jehudah Zachary 2024
# Similar Projects
- [Easy XMPP Invitation Landing Page](https://github.com/modernxmpp/easy-xmpp-invitation) from Mr. Georg Lukas;
- [mod_invite](https://modules.prosody.im/mod_invite.html) module for Prosody.