SDK Migration Guide: v1 to v2

Edited 02/27/2024

This guide provides instructions for migrating your application from version 1 of the SDK to version 2.

Overview

Version 2 of the SDK introduces several new features and improvements, as well as breaking changes. This guide will walk you through the necessary steps to update your application code to work with the latest version of the SDK.

Prerequisites

Before starting the migration process, ensure that you have the following:

Access to the latest version 2 of the SDK.
A backup of your existing application code.

Migration Steps

Follow these steps to migrate your application from SDK version 1 to version 2:

Review Release Notes: Start by reviewing the release notes for version 2 of the SDK. This will give you an overview of the changes and new features introduced in the latest version.
Update Dependencies: Update the SDK dependency in your project to version 2. You can do this by updating the dependency version in your package.json file and running npm install, yarn install or pnpm add @crossmarkio/sdk to install the latest version.
Check for Breaking Changes: Review the list of breaking changes introduced in version 2. Make note of any changes that may impact your application code, such as deprecated methods or renamed functions.

. . .

Additional Resources

SDK Documentation: Refer to the official SDK documentation for detailed information on using version 2 of the SDK.
Discord Channel: Join the discord community to ask questions, share tips, and collaborate with other developers.

Conclusion

By following these migration steps, you can successfully update your application to use version 2 of the SDK. If you encounter any issues during the migration process, don't hesitate to reach out to the SDK community for assistance.