From 4828306c9ed104c081dffbb56c022795589e096f Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Tue, 15 Nov 2022 12:47:46 -0700 Subject: [PATCH 1/2] Define a spec support policy for the js-sdk --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5e7de61a17f..92f3876633f 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,14 @@ Matrix Javascript SDK ===================== -This is the [Matrix](https://matrix.org) Client-Server r0 SDK for -JavaScript. This SDK can be run in a browser or in Node.js. +This is the [Matrix](https://matrix.org) Client-Server SDK for JavaScript and TypeScript. This SDK can be run in a +browser or in Node.js. + +The Matrix specification is constantly evolving - while this SDK aims for maximum backwards compatibility, it only +guarantees that a feature will be supported for at least 3 spec releases. For example, if a feature the js-sdk supports +is removed in v1.4 then the feature is *eligible* for removal from the SDK when v1.7 is released. This SDK has no +guarantee on implementing all features of any particular spec release, currently. This can mean that the SDK will call +endpoints from before Matrix 1.1, for example. Quickstart ========== From c2cd30fffd7350056d55ed686ab1a39d99edf6e2 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 17 Nov 2022 14:21:51 -0700 Subject: [PATCH 2/2] Update timeline per team discussion --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92f3876633f..19592b0ea8f 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ This is the [Matrix](https://matrix.org) Client-Server SDK for JavaScript and Ty browser or in Node.js. The Matrix specification is constantly evolving - while this SDK aims for maximum backwards compatibility, it only -guarantees that a feature will be supported for at least 3 spec releases. For example, if a feature the js-sdk supports -is removed in v1.4 then the feature is *eligible* for removal from the SDK when v1.7 is released. This SDK has no +guarantees that a feature will be supported for at least 4 spec releases. For example, if a feature the js-sdk supports +is removed in v1.4 then the feature is *eligible* for removal from the SDK when v1.8 is released. This SDK has no guarantee on implementing all features of any particular spec release, currently. This can mean that the SDK will call endpoints from before Matrix 1.1, for example.