You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+61-33Lines changed: 61 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,45 @@
1
-
# Spixi
2
-
Spixi is a multiplatform, decentralized and privacy-oriented chat application that brings together users from different platforms. Because Spixi operates on top of Ixian S2 and DLT networks, it includes a set of distinctive features:
1
+
# Spixi
3
2
4
-
* Decentralized architecture ensures practically no downtime. Backend is based on the Ixian DLT and Ixian S2 streaming network to provide ultimate decentralization and security.
5
-
* Cryptographically secure (dual end-to-end encryption), which means that only the intended recipient can read messages.
6
-
* Multi-platform (PC, iOS, Android, others)
7
-
* Ixian DLT integration, which enables cryptocurrency wallet features right in the IM client.
8
-
* Messages are not stored in any one country or central location. There is no legal or corporate entity that possesses all of the messages, so no entity can meaningfully demand or obtain decryption keys.
3
+
**Spixi** is a decentralized, privacy-first **communications app** built on the [Ixian Platform](https://www.ixian.io).
4
+
It combines **messaging, voice and video calls, file sharing, crypto wallet functionality, and Mini Apps** in a single,
5
+
cross-platform experience - with Post-Quantum Cryptography (PQC) and no central servers.
9
6
7
+
Unlike traditional messengers that rely on central servers to store keys and mediate authentication, Spixi users **hold and
8
+
control their own encryption keys locally**. Every conversation is uniquely encrypted, and identities are proven cryptographically
9
+
without passwords, central accounts, or third-party trust.
10
10
11
-
## Development branches
11
+
---
12
12
13
-
There are two main development branches:
14
-
***master**: This branch is used to build the binaries for the latest stable release of Spixi. It should change slowly and be quite well-tested. This is also the default branch for anyone who wishes to build their Ixian software from source.
15
-
***development**: This is the main development branch. The branch might not always be kept bug-free, if an extensive new feature is being worked on. If you are simply looking to build a current binary yourself, please use one of the release tags which will be associated with the master branch.
13
+
## 🚀 Why Spixi?
16
14
17
-
## Documentation
15
+
* ⚛️ **Post-Quantum Resistant Security** - Hybrid key exchange (`RSA + ECDH + Kyber/ML-KEM`) ensures confidentiality even against
16
+
future quantum threats.
17
+
* 🔒 **True End-to-End Encryption** - Dual encryption (AES + ChaCha20-Poly1305). Keys never leave the user's device, and each
18
+
contact-pair uses unique cryptographic keys. Only the sender and intended recipient can ever decrypt a message.
19
+
* 🧬 **Self-Authentication, Not Server Authentication** - In centralized systems, a username and password authenticate you to a
20
+
server, which then manages or even stores your keys. In Ixian, **your cryptographic address is your identity**, and you sign
21
+
messages yourself with your private key. No servers vouch for you - your identity and communication security are entirely under
22
+
your control.
23
+
* 🕸️ **Decentralized by Design** - Runs peer-to-peer over Ixian's **DLT** and **S2 presence network**. Client discovery works
24
+
via cryptographic addresses and signed presence packets (not DNS, IP, or certificate authorities), ensuring authenticity and
25
+
privacy.
26
+
* 📱 **Cross-Platform** - Works on Android, iOS, Windows, and macOS.
27
+
* 💬 **Rich Communication** - Chat, group messaging, voice calls, reactions, emojis, and file sharing.
28
+
* 💸 **Built-In Crypto Wallet** - Send and receive IXI transactions directly inside the app.
29
+
* 🧩 **Extensible with Mini Apps** - Developers can build secure, in-app extensions and workflows within Spixi.
18
30
19
-
You can find documentation on how to build, APIs and other documents on [Ixian Documentation Pages](https://docs.ixian.io).
31
+
---
20
32
21
-
## Build Instructions
33
+
## 📚 Documentation
22
34
23
-
### Prerequisites
35
+
Developer documentation, build guides, and API references are available at:
36
+
👉 [docs.ixian.io](https://docs.ixian.io)
37
+
38
+
---
24
39
25
-
Before you start, ensure you have the following prerequisites installed:
40
+
## 🛠️ Build Instructions
41
+
42
+
### Prerequisites
26
43
27
44
- .NET 8 SDK or later
28
45
- Visual Studio 2022 or later (with .NET MAUI workload installed)
@@ -33,7 +50,7 @@ Before you start, ensure you have the following prerequisites installed:
33
50
First, you need to clone the repository to your local machine. Open your terminal or Git Bash and run the following command:
- For detailed guidance on setting up your development environment, refer to the official [Microsoft .NET MAUI documentation](https://docs.microsoft.com/en-us/dotnet/maui/).
93
-
- If you encounter any issues, please check the [issues](https://github.com/ProjectIxian/Spixi/issues) section on the repository for existing solutions or open a new issue.
110
+
- If you encounter any issues, please check the [issues](https://github.com/ixian-platform/Spixi/issues) section on the repository for existing solutions or open a new issue.
94
111
- **For iOS Development:**
95
112
- You need a Mac to build and run the application on iOS.
96
113
- Follow the .NET MAUI documentation to set up your Mac environment. This includes enabling remote access, installing Xcode, and setting up Xcode command line tools.
97
114
- Detailed instructions can be found in the [official .NET MAUI documentation for iOS setup](https://learn.microsoft.com/en-us/dotnet/maui/ios/pair-to-mac?view=net-maui-8.0).
98
115
116
+
---
99
117
100
-
## Get in touch / Contributing
118
+
## 🌱 Development Branches
101
119
102
-
If you feel like you can contribute to the project, or have questions or comments, you can get in touch with the team through Discord: https://discord.gg/pdJNVhv
120
+
* **master** - Stable, production-ready releases
121
+
* **development** - Active development, may contain unfinished features
103
122
104
-
## Pull requests
123
+
For reproducible builds, always use the latest **release tag** on `master`.
105
124
106
-
If you would like to send an improvement or a bug fix to this repository, but without permanently joining the team, follow these approximate steps:
125
+
---
107
126
108
-
1. Fork this repository
109
-
2. Create a branch from **development** branch (preferably with a name that describes the change)
110
-
3. Create commits (the commit messages should contain some information on what and why was changed)
111
-
4. Create a pull request to this repository's **development** branch for review and inclusion
127
+
## 🤝 Contributing
128
+
129
+
We welcome contributions from developers, integrators, and builders.
112
130
131
+
1. Fork this repository
132
+
2. Create a feature branch (`feature/my-change`)
133
+
3. Commit with descriptive messages
134
+
4. Open a Pull Request against `development`
113
135
114
-
## About Ixian
136
+
Join the community on **[Discord](https://discord.gg/pdJNVhv)**.
115
137
116
-
Ixian DLT is a revolutionary blockchain that brings several innovative advantages, such as processing a high volume of micro-transactions quickly while consuming a low amount of processing power, disk space and energy.
0 commit comments