Rebranded to axiom
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
<h1 align="center">
|
||||
<br>
|
||||
<a href="https://vxchat.netlify.app/"><img src="./public/voxa.svg" alt="VOXA"></a>
|
||||
<a href="https://vxchat.netlify.app/"><img src="./public/axiom.svg" alt="Axiom" height="30"></a>
|
||||
</h1>
|
||||
|
||||
<h4 align="center">Chat. Connect. Collaborate.</h4>
|
||||
@@ -34,33 +34,33 @@ SUPABASE_SERVICE_ROLE_KEY=""
|
||||
|
||||
## Features
|
||||
|
||||
- Private: Messages can be handled by the server / node, voxa can't access them.
|
||||
- Private: Messages can be handled by the server / node, axiom can't access them.
|
||||
- Customizable: Customize your server with plugins, a replacement for bots.
|
||||
|
||||
## Keywords
|
||||
|
||||
- Voxa Client: The user-side app which communicates with all below.
|
||||
- Voxa Cloud: The authentication and user management handler.
|
||||
- Voxa Server: The self-host-able community/friends communication service.
|
||||
- Voxa Node: The self-host-able Private Message communication service, also used for sending notifications.
|
||||
- Axiom Client: The user-side app which communicates with all below.
|
||||
- Axiom Cloud: The authentication and user management handler.
|
||||
- Axiom Server: The self-host-able community/friends communication service.
|
||||
- Axiom Node: The self-host-able Private Message communication service, also used for sending notifications.
|
||||
|
||||
## Node Structure
|
||||
|
||||
The Direct-Message structure works like Email, but real-time and the node uses a temporary auth, a node is what stores messages that are sent by a user.
|
||||
|
||||
This diagram shows that in order to send a message to a user, you must connect to their chosen node, which can be accessed via the Voxa Cloud and connected to directly.
|
||||
This diagram shows that in order to send a message to a user, you must connect to their chosen node, which can be accessed via the Axiom Cloud and connected to directly.
|
||||
|
||||
A node message can be a DM (Direct Message between two parties), or a SM (Server Message from a community).
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant AliceClient as Alice's Client
|
||||
participant Voxa as Voxa Cloud
|
||||
participant Axiom as Axiom Cloud
|
||||
participant BobNode as Bob's Selected Node (Node2)
|
||||
participant BobClient as Bob's Client
|
||||
|
||||
AliceClient->>Voxa: Lookup Bob's node
|
||||
Voxa-->>AliceClient: Respond with Bob → Node2
|
||||
AliceClient->>Axiom: Lookup Bob's node
|
||||
Axiom-->>AliceClient: Respond with Bob → Node2
|
||||
AliceClient->>BobNode: Authenticate and Send DM to bob
|
||||
BobNode-->>AliceClient: Acknowledge message stored
|
||||
BobNode->>BobClient: Notify new message
|
||||
@@ -78,7 +78,7 @@ flowchart TD
|
||||
A --> B{Is Bob connected<br>to this server?}
|
||||
B -- Yes --> C[Deliver directly<br>to Bob's client]
|
||||
C --> D[Ack received]
|
||||
B -- No --> E[Lookup Bob's selected node<br>via Voxa Cloud]
|
||||
B -- No --> E[Lookup Bob's selected node<br>via Axiom Cloud]
|
||||
E --> F[Forward message<br>to Bob's node]
|
||||
F --> G[Bob's node notifies<br>Bob's client]
|
||||
G --> H[Ack flows back]
|
||||
@@ -91,14 +91,14 @@ This sequence happens when you connect to a server or node.
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Alice as Alice's Client
|
||||
participant Voxa as Voxa Cloud
|
||||
participant Axiom as Axiom Cloud
|
||||
participant Server as Node / Server
|
||||
|
||||
Alice->>Voxa: Register token for the (Node / Server)
|
||||
Voxa-->>Alice: TOKEN
|
||||
Alice->>Axiom: Register token for the (Node / Server)
|
||||
Axiom-->>Alice: TOKEN
|
||||
Alice->>Server: Authenticate with TOKEN
|
||||
Server->>Voxa: Authenticate with TOKEN
|
||||
Voxa-->>Server: The user is Alice
|
||||
Server->>Axiom: Authenticate with TOKEN
|
||||
Axiom-->>Server: The user is Alice
|
||||
Server-->>Alice: You are Alice
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user