Skip to content

github-analyzer: add README.md for contentsquare/dc_ios_binary_framework_sample #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cs-gh-analyzer-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

github-analyzer: add README.md for contentsquare/dc_ios_binary_framework_sample #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.