diff --git a/README.md b/README.md new file mode 100644 index 0000000..061b6d7 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# ContentSquare iOS Binary Framework Sample + +A minimal sample project demonstrating how to integrate the [ContentSquare](https://contentsquare.com) iOS SDK delivered as a pre-built binary framework. + +## Overview + +This repository is intended as a reference for teams consuming ContentSquare iOS binary frameworks in an Xcode workspace. It shows the recommended project structure and build configuration required to link against the pre-built `.xcframework` / `.framework` artifacts. + +## Repository Structure + +``` +. +├── BinaryFrameworksSample/ # Sample Xcode app target +├── Contentsquare/ # Pre-built ContentSquare binary framework(s) +├── Makefile # Convenience build & setup commands +└── .github/ # CI workflows and CODEOWNERS +``` + +## Requirements + +- Xcode 14+ +- iOS deployment target compatible with the bundled framework version + +## Getting Started + +1. Clone the repository: + ```bash + git clone https://github.com/contentsquare/dc_ios_binary_framework_sample.git + ``` +2. Open the Xcode workspace: + ```bash + open BinaryFrameworksSample/*.xcworkspace + ``` + *(or use `make` — run `make help` to see available targets)* +3. Build and run the sample target on a simulator or device. + +## Ownership + +This project is maintained by the ContentSquare iOS platform team (`@ContentSquare/ios`). + +## License + +Internal ContentSquare use. No open-source license is currently declared.