Skip to content

Commit

Permalink
Define a spec support policy for the js-sdk (#2882)
Browse files Browse the repository at this point in the history
* Define a spec support policy for the js-sdk

* Update timeline per team discussion
  • Loading branch information
turt2live authored Nov 25, 2022
1 parent aaf3702 commit ad16b26
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

Quickstart
==========
Expand Down

0 comments on commit ad16b26

Please sign in to comment.