nataliab / cleanroomdatatransactions

A protocol-independent and format-agnostic Swift library for performing one-way and two-way data transactions

CleanroomDataTransactions

A protocol-independent and format-agnostic Swift library for performing one-way and two-way data transactions.

CleanroomDataTransactions is part of the Cleanroom Project from Gilt Tech.

Swift 2.1 compatibility

The master branch of this project is Swift 2.1 compliant and therefore requires Xcode 7.1 or higher to compile.

It is also known to work with Swift 2.1.1 in Xcode 7.2.

Adding CleanroomDataTransactions to your project

You’ll need to integrate CleanroomDataTransactions into your project in order to use the API it provides. You can choose:

• Manual integration, wherein you embed CleanroomDataTransactions’s Xcode project within your own, or
• Using the Carthage dependency manager to build a framework that you then embed in your application.

Once integrated, just add the following import statement to any Swift file where you want to use CleanroomDataTransactions:

import CleanroomDataTransactions

API documentation

For detailed information on using CleanroomDataTransactions, API documentation is available.

About

The Cleanroom Project began as an experiment to re-imagine Gilt’s iOS codebase in a legacy-free, Swift-based incarnation.

Since then, we’ve expanded the Cleanroom Project to include multi-platform support. Much of our codebase now supports tvOS in addition to iOS, and our lower-level code is usable on Mac OS X and watchOS as well.

Cleanroom Project code serves as the foundation of Gilt on TV, our tvOS app featured by Apple during the launch of the new Apple TV. And as time goes on, we'll be replacing more and more of our existing Objective-C codebase with Cleanroom implementations.

In the meantime, we’ll be tracking the latest releases of Swift & Xcode, and open-sourcing major portions of our codebase along the way.

Contributing

CleanroomDataTransactions is in active development, and we welcome your contributions.

If you’d like to contribute to this or any other Cleanroom Project repo, please read the contribution guidelines.

Acknowledgements

API documentation for CleanroomDataTransactions is generated using Realm’s jazzy project, maintained by JP Simard and Samuel E. Giddins.