From b510b27d8ae4826157149f3f39b0cebbd6729928 Mon Sep 17 00:00:00 2001
From: Hiranmaya Gundu <hiranmaya@sigmacomputing.com>
Date: Fri, 23 Aug 2024 10:46:30 -0700
Subject: [PATCH] chore: add the version policy to the README

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a90aec8..4fb732f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # Sigma Embed-SDK for React
+
 Sigma provides several methods to allow users and developers to interact with its systems including web-ui, REST API, Javascript Embed API and an SDK for the React framework.
 
 The Embed-SDK for React offers a higher-level, developer-friendly interface that simplifies integration into applications, in contrast to Sigma’s lower-level JavaScript Embed-API, which provides more granular control but may require additional coding
@@ -6,45 +7,55 @@ The Embed-SDK for React offers a higher-level, developer-friendly interface that
 If the basic instructions below are not sufficient, please review the [QuickStart here.](https://quickstarts.sigmacomputing.com/guide/embedding_15_embed_sdk/index.html?index=..%2F..index#0)
 
 ## Using in Project
+
 To use the embed-sdk in your project, you can install it using your node package manager.
 
 ### For react-embed-sdk:
+
 For each package manager, use the following command:
 
 **npm:**
+
 ```code
 npm install @sigmacomputing/react-embed-sdk
 ```
 
 **yarn:**
+
 ```code
 yarn add @sigmacomputing/react-embed-sdk
 ```
 
 **pnpm:**
+
 ```code
 pnpm add @sigmacomputing/react-embed-sdk
 ```
 
 ### For embed-sdk:
+
 For each package manager, use the following command:
 
 **Using npm:**
+
 ```code
 npm install @sigmacomputing/embed-sdk
 ```
 
 **yarn:**
+
 ```code
 yarn add @sigmacomputing/embed-sdk
 ```
 
 **pnpm:**
+
 ```code
 pnpm add @sigmacomputing/embed-sdk
 ```
 
 ## Building
+
 The repo uses turbo for its build system. It currently has 3 packages:
 
 - embed-sdk: "barebones" wrappers over postMessages
@@ -52,12 +63,18 @@ The repo uses turbo for its build system. It currently has 3 packages:
 - docs: Some barebone documentation / examples.
 
 **To build:**
+
 ```code
 pnpm run build
 ```
 
-## Publish flow:
+## Release and Publish flow:
+
+We follow [semantic versioning](https://semver.org/). We MAY make breaking changes while in 0.y.z releases, but the
+maintainers do not plan for any substantial breaking changes until 1.0.0.
+
 Publishes are handled by changesets. To add a changeset, in your PR run:
+
 ```code
 pnpm changeset
 ```
@@ -65,5 +82,6 @@ pnpm changeset
 This will prompt you to add a changeset. Once merged, a PR will be opened to bump the version and publish the package.
 
 ## Adding iframe events
+
 - [Example](https://github.com/sigmacomputing/embed-sdk/pull/31) for adding an inbound event
 - Add a changeset for both the embed-sdk and react-embed-sdk.