![MobileCoin logo](https://raw.githubusercontent.com/mobilecoinofficial/mobilecoin/master/img/mobilecoin_logo.png)

[![CircleCI](https://img.shields.io/circleci/build/gh/mobilecoinofficial/MobileCoin-Swift?token=da755dc2814021ad04ee7b31a129b41e6c7161ac)](https://circleci.com/gh/mobilecoinofficial/MobileCoin-Swift/tree/master) [![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://mobilecoinofficial.github.io/MobileCoin-Swift/)

# MobileCoin Swift

MobileCoin is a privacy-preserving payments network designed for use on mobile devices.

# Sending your First Payment

* You must read and accept the [Terms of Use for MobileCoins and MobileCoin Wallets](./TERMS-OF-USE.md) to use MobileCoin Software.

### Note to Developers

* MobileCoin is a prototype. Expect substantial changes before the release.
* Please see [*CONTRIBUTING.md*](./CONTRIBUTING.md) for notes on contributing bug reports and code.

# Table of Contents
- [License](#license)
- [Cryptography Notice](#cryptography-notice)
- [Repository Structure](#repository-structure)
- [Build Instructions](#build-instructions)
- [Overview](#overview)
- [Support](#support)
- [Trademarks](#trademarks)

## License

MobileCoin is available under open-source licenses. Please read the [*LICENSE.md*](./LICENSE.md) and corresponding [*LICENSE*](./LICENSE).

## Cryptography Notice
This distribution includes cryptographic software. Your country may have restrictions on the use of encryption software. 
Please check your country's laws before downloading or using this software.

## Repository Structure
|Directory |Description |
| :-- | :-- |
| [Example](./Example) | Example application. |
| [Sources](./Sources) | Sources for the MobileCoin Swift SDK. |
| [Tests](./Tests) | Tests. |
| [Vendor](./Vendor) | iOS Artifacts. |

## Build Instructions

The workspace can be built with `make`.

1. Initialize or update submodules

    ```
    git submodule update --init --recursive
    ```

1. Install Ruby

1. Install the gem bundler

    ```
    gem install bundler
    ```

1. Build the MobileCoin Swift SDK

    ```
    make
    ```

Note: To build libmobilecoin, run `make` in [libmobilecoin-ios-artifacts](./Vendor/libmobilecoin-ios-artifacts).

## Overview

MobileCoin is a payment network with no central authority. The fundamental goal of the network is to safely and 
efficiently enable the exchange of value, represented as fractional ownership of the total value of the network. 
Like most cryptocurrencies, MobileCoin maintains a permanent and immutable record of all successfully completed 
payments in a blockchain data structure. Cryptography is used extensively to establish ownership, control transfers, 
and to preserve cash-like privacy for users.

For more information about the cryptocurrency, see [MobileCoinFoundation/MobileCoin](https://github.com/mobilecoinfoundation/mobilecoin).

## Support

For troubleshooting help and other questions, please visit our [community forum](https://community.mobilecoin.foundation/).

You can also open a technical support ticket via [email](mailto://support@mobilecoin.com).

#### Trademarks

MobileCoin is a registered trademark of MobileCoin Inc.