Skip to content
Snippets Groups Projects
README.md 21.06 KiB

xx network Client

Repository | Go Doc | Examples

The client is a library and related command-line tool that facilitates making full-featured xx clients for all platforms. It interfaces with the cMix system, enabling access to all xx network messaging features, including end-to-end encryption and metadata protection.

This repository contains everything necessary to implement the xx network messaging features. In addition, it also contains features to extend the base messaging protocols.

The command-line tool accompanying the client library can be built for any platform supported by Go. The libraries are built for iOS and Android using gomobile.

For library writers, the client requires a writable folder to store data, functions for receiving and approving requests for creating secure end-to-end messaging channels, discovering users, and receiving different types of messages.

The client is open-source software released under the simplified BSD License.

Command Line Usage

The command-line tool is intended for testing xx network functionality and not for regular user use.

These instructions assume that you have Go 1.17.X installed and GCC installed for cgo (such as build-essential on Debian or Ubuntu).