Skip to content
Snippets Groups Projects
Commit 9e160646 authored by Jemimah Omodior's avatar Jemimah Omodior
Browse files

Update "Overview" doc

parent c0eaeced
No related branches found
No related tags found
1 merge request!2Bring master up to date, merge updated CI
---
id: overview
slug: /
id: overview
sidebar_position: 1
---
# Overview
The Client API (xxDK) is the client-side software for communicating with the cMix network, a privacy protecting layer within the larger xx network. cMix builds on current data protection mechanisms by extending security beyond just content to include metadata — the what, when, where, and how of user activity.
The Client API (xxDK) is the client-side software for communicating with the cMix network, a privacy-protecting layer within the larger xx network. cMix builds on current data protection mechanisms by extending security beyond just content to include metadata — the what, when, where, and how of user activity.
The xxDK helps developers provide unparalleled privacy for their users by implementing xx network messaging features such as end-to-end encryption and metadata protection. It comes with an API library and related command line facilities that enable developers build full-featured xx clients for all platforms. Additionally, the base messaging protocols can be extended.
The xxDK helps developers provide unparalleled privacy for their users by implementing xx network messaging features such as end-to-end encryption and metadata protection. It comes with an API library and related command-line facilities that enable developers to build full-featured xx clients for all platforms. Additionally, the base messaging protocols can be extended.
Some use cases for integrating the API into your applications include (but are not limited to) building:
......@@ -16,25 +16,25 @@ Some use cases for integrating the API into your applications include (but are n
- Secure messaging apps for private communications
:::info
If you'd like to learn more about the cMix protocol and what it offers, a good place to start is [the cMix whitepaper](https://xx.network/xxcMixwhitepaper.pdf).
:::
The client API supports golang versions 1.17 or newer. You can find the most recent version at [https://git.xx.network/elixxir/client](https://git.xx.network/elixxir/client).
It's easy to get started with the xxDK. Explore these links below to find what you need.
### Getting Started
### [Getting Started](./getting-started.md)
The [Getting Started](./getting-started) guide is the place to begin if you're looking to get up-and-running quickly.
The Getting Started guide is where to begin if you're looking to get up and running quickly.
<!-- ### The API Reference
### [The API Reference](./quick-reference.md)
The API Reference provides extensive detail on the different types and functions exposed by the Client API.
### Technical Glossary
### [Technical Glossary](./technical-glossary.md)
Use the technical glossary to find meanings to unfamiliar terms and concepts specific to the cMix system.
### FAQs
<!-- ### FAQs
Refer to the FAQ for answers to some of our users' most common questions. -->
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment