From 4849d7fa56065978f456e76719bc50cbe1bca9f5 Mon Sep 17 00:00:00 2001
From: Lucas Rosa <lucas@telnyx.com>
Date: Mon, 14 Oct 2024 20:41:36 -0300
Subject: [PATCH] add Versions info

---
 README.md   | 11 ++++++++---
 VERSION     |  2 +-
 VERSIONS.md | 35 +++++++++++++++++++++++++++++++++++
 3 files changed, 44 insertions(+), 4 deletions(-)
 create mode 100644 VERSIONS.md

diff --git a/README.md b/README.md
index 071938c..83374e3 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,10 @@ applications written in server-side JavaScript.
 
 See the [Node API docs](https://developers.telnyx.com/docs/api/v2/overview?lang=node#getting-started).
 
+## Versions
+
+`telnyx-node` uses a slightly modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.
+
 ## Installation
 
 Install the package with:
@@ -43,9 +47,10 @@ callback:
 
 ```typescript
 // Create a new messaging profile and then send a message using that profile:
-telnyx.messagingProfiles.create({
-  name: 'Summer Campaign',
-})
+telnyx.messagingProfiles
+  .create({
+    name: 'Summer Campaign',
+  })
   .then((messagingProfile) => {
     return telnyx.messagingPhoneNumbers.update('+18005554000', {
       messaging_profile_id: messagingProfile.data.id,
diff --git a/VERSION b/VERSION
index e2d1981..96cabdf 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.0.0-beta.2
+2.0.0-beta.3
diff --git a/VERSIONS.md b/VERSIONS.md
new file mode 100644
index 0000000..3e9aa90
--- /dev/null
+++ b/VERSIONS.md
@@ -0,0 +1,35 @@
+# Versioning Strategy
+
+`telnyx-node` uses a modified version of [Semantic Versioning][semver] for
+all changes to the helper library. It is strongly encouraged that you pin at
+least the major version and potentially the minor version to avoid pulling in
+breaking changes.
+
+Semantic Versions take the form of `MAJOR.MINOR.PATCH`
+
+When bugs are fixed in the library in a backwards-compatible way, the `PATCH`
+level will be incremented by one. When new features are added to the library
+in a backwards-compatible way, the `PATCH` level will be incremented by one.
+`PATCH` changes should _not_ break your code and are generally safe for upgrade.
+
+When a new large feature set comes online or a small breaking change is
+introduced, the `MINOR` version will be incremented by one and the `PATCH`
+version reset to zero. `MINOR` changes _may_ require some amount of manual code
+change for upgrade. These backwards-incompatible changes will generally be
+limited to a small number of function signature changes.
+
+The `MAJOR` version is used to indicate the family of technology represented by
+the helper library. Breaking changes that require extensive reworking of code
+will cause the `MAJOR` version to be incremented by one, and the `MINOR` and
+`PATCH` versions will be reset to zero. Telnyx understands that this can be very
+disruptive, so we will only introduce this type of breaking change when
+absolutely necessary. New `MAJOR` versions will be communicated in advance with
+`Release Candidates` and a schedule.
+
+## Supported Versions
+
+Only the current `MAJOR` version of `telnyx-node` is supported. New
+features, functionality, bug fixes, and security updates will only be added to
+the current `MAJOR` version.
+
+[semver]: https://semver.org