Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions DEPRECATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# CocoaPods persistence modules (ContentstackPersistence, Core Data, Realm)

This notice applies to the **CocoaPods** distribution of the Contentstack **iOS Persistence** add-ons—pods such as `ContentstackPersistence`, `ContentstackPersistenceCoreData`, and `ContentstackPersistenceRealm`—that work with the **legacy Objective-C Content Delivery SDK** delivered via CocoaPods.

## Who this is for

You should read this if you integrate these persistence modules through **CocoaPods**, or if you are choosing how to add offline storage and sync-related persistence for a **new** iOS or Apple platform app.

## What we recommend for new work

For **new** applications and greenfield projects, use the **[Contentstack Swift SDK](https://github.com/contentstack/contentstack-swift)** and add it with **Swift Package Manager (SPM)**—for example via the [Swift Package Index listing](https://swiftpackageindex.com/contentstack/contentstack-swift). See the **[Swift Content Delivery API reference](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/swift/reference)** for API details.

These CocoaPods persistence modules sit on the **legacy Objective-C CDA + CocoaPods** path. That path is **deprecated for new work**. We are **not** shipping a CocoaPods-first persistence package aligned with the Swift SDK; instead, **handle persistence with your own approach** (Core Data, Realm, or other storage) using the Swift SDK’s APIs, and follow **published product guidance** for sync and offline patterns where we provide it.

## If you already ship with these pods

**Existing** projects that already depend on these CocoaPods can **continue to use and ship** them. Deprecation here means we are **not recommending** this integration path for **new** projects—not that you must stop shipping tomorrow. Plan a **migration when it makes sense** for your product (for example, when you adopt the Swift SDK and SPM, or when you rework offline storage).

## Why we are deprecating the CocoaPods persistence path for new projects

**CocoaPods and the trunk specs workflow** are part of a broader ecosystem shift; the CocoaPods project has described changes around the [Specs repo and distribution](https://blog.cocoapods.org/CocoaPods-Specs-Repo/). Separately, Contentstack’s **product direction** for Apple platforms is the **Swift SDK** and **SPM**, which is where we focus **new** features and documentation.

Together, that means the **CocoaPods persistence modules**—as add-ons on the legacy Objective-C stack—are **not** the path we want **new** customers to adopt.

## Maintenance compared with new features

We may still provide **limited maintenance** (for example, compatibility or critical fixes) for existing CocoaPods users where feasible. **New** capabilities and improvements are expected to land in the **Swift SDK** and related **SPM**-based workflows, not in new CocoaPods-only persistence features.

## Dates and expectations

We are not publishing a single “end of life” date for these pods in this document. Treat **today** as the point from which **new** projects should **not** start on this CocoaPods persistence path; use the Swift SDK and SPM instead. Watch this repository’s **[changelog](changelog.md)**, **[README](README.md)**, and **[Docs/overview](Docs/overview.md)** for any later updates.

## Help and support

If you need help with your stack, contract, or migration planning, contact **[Contentstack support](https://www.contentstack.com/support/)**.

For the full customer-facing summary, see **[README.md](README.md)** (Important section at the top).
14 changes: 14 additions & 0 deletions Docs/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Overview

## Important

The **CocoaPods** persistence modules in this repository (`ContentstackPersistence`, `ContentstackPersistenceCoreData`, `ContentstackPersistenceRealm`) are **add-ons** on the **legacy Objective-C Content Delivery SDK + CocoaPods** path. That path is **deprecated for new work**.

- **New apps** should use the **[Contentstack Swift SDK](https://github.com/contentstack/contentstack-swift)** with **Swift Package Manager** ([Swift Package Index](https://swiftpackageindex.com/contentstack/contentstack-swift)) and implement persistence yourself (or follow published guidance). The Swift CDA reference is **[here](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/swift/reference)**.
- **Existing** CocoaPods-based apps may **continue shipping**; migrate when you are ready.

For the full deprecation notice, see **[DEPRECATION.md](../DEPRECATION.md)**.

---

This folder complements the main **[README](../README.md)** for the Contentstack **iOS Persistence Library** (Core Data and Realm integration with the legacy Objective-C stack).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2012-2023 Contentstack (http://app.contentstack.com)
Copyright (c) 2012-2026 Contentstack (http://app.contentstack.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)

## Important

The **CocoaPods** persistence modules in this repository (`ContentstackPersistence`, `ContentstackPersistenceCoreData`, `ContentstackPersistenceRealm`) are **add-ons** on the **legacy Objective-C Content Delivery SDK + CocoaPods** path. That path is **deprecated for new work**.

- **New apps** should use the **[Contentstack Swift SDK](https://github.com/contentstack/contentstack-swift)** with **Swift Package Manager** ([Swift Package Index](https://swiftpackageindex.com/contentstack/contentstack-swift)) and implement persistence yourself (or follow published guidance). The Swift CDA reference is **[here](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/swift/reference)**.
- **Existing** CocoaPods-based apps may **continue shipping**; migrate when you are ready.

For full details, see **[DEPRECATION.md](DEPRECATION.md)**.

---

# Contentstack iOS Persistence Library

Contentstack provides [iOS Persistence Library](https://www.contentstack.com/docs/guide/synchronization/using-realm-persistence-library-with-ios-sync-sdk) that lets your application store data on the device's local storage. This helps you build apps that can work offline too. Given below is a detailed guide and helpful resources to get started with our iOS Persistence Library.
Expand Down Expand Up @@ -145,6 +156,7 @@ We have created an example app using iOS Persistence Library that stores data on

### Helpful Links

- [Repository overview](Docs/overview.md)
- [iOS Persistence Library Docs](https://www.contentstack.com/docs/guide/synchronization/using-realm-persistence-library-with-ios-sync-sdk)
- [iOS Persistence Example App](https://github.com/contentstack/contentstack-ios-persistence-example)
- [Content Delivery API Docs](https://contentstack.com/docs/apis/content-delivery-api/)
Expand Down
6 changes: 6 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Changelog

### Documentation

#### Date: Apr-02-2026

- Published CocoaPods deprecation guidance for this repository: added an **Important** section at the top of **README.md**, a customer-facing **DEPRECATION.md** at the repository root, and **Docs/overview.md** (banner aligned with the README, linking to `DEPRECATION.md`).

### Version 0.0.3 (2019-04-16) ###

#### Changes
Expand Down
Loading