Update readmes for 3.0 (#3836)

lit · Apr 24, 2023 · 9b2659b · 9b2659b
1 parent e26adb9
commit 9b2659b
Show file tree

Hide file tree

Showing 7 changed files with 92 additions and 6 deletions.
diff --git a/.changeset/hungry-paws-beam.md b/.changeset/hungry-paws-beam.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/lit-element/README.md b/packages/lit-element/README.md
@@ -11,7 +11,19 @@ LitElement is the base class that powers the [Lit](https://lit.dev) library for
 
 ## About this release
 
-This is a stable release of `lit-element` 3.0.0 (part of the Lit 2.0 release). If upgrading from previous versions of `lit-element`, please see the [Upgrade Guide](https://lit.dev/docs/releases/upgrade/) for a step-by-step guide on upgrading.
+This is a pre-release of Lit 3.0, the next major version of Lit.
+
+Lit 3.0 has very few breaking changes from Lit 2.0:
+
+- Drops support for IE11
+- Published as ES2021
+- Removes a couple of deprecated Lit 1.x APIs
+
+Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
+
+Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
+
+Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
 
 ## Documentation
 

diff --git a/packages/lit-html/README.md b/packages/lit-html/README.md
@@ -11,7 +11,19 @@ lit-html is the template system that powers the [Lit](https://lit.dev) library f
 
 ## About this release
 
-This is a stable release of `lit-html` 2.0 (part of the Lit 2.0 release). If upgrading from previous versions of `lit-html`, please note the minor breaking changes from lit-html 1.0 in the [Upgrade Guide](https://lit.dev/docs/releases/upgrade/).
+This is a pre-release of Lit 3.0, the next major version of Lit.
+
+Lit 3.0 has very few breaking changes from Lit 2.0:
+
+- Drops support for IE11
+- Published as ES2021
+- Removes a couple of deprecated Lit 1.x APIs
+
+Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
+
+Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
+
+Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
 
 ## Documentation
 

diff --git a/packages/lit-starter-js/README.md b/packages/lit-starter-js/README.md
@@ -6,6 +6,22 @@ This template is generated from the `lit-starter-js` package in [the main Lit
 repo](https://github.com/lit/lit). Issues and PRs for this template should be
 filed in that repo.
 
+## About this release
+
+This is a pre-release of Lit 3.0, the next major version of Lit.
+
+Lit 3.0 has very few breaking changes from Lit 2.0:
+
+- Drops support for IE11
+- Published as ES2021
+- Removes a couple of deprecated Lit 1.x APIs
+
+Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
+
+Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
+
+Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
+
 ## Setup
 
 Install dependencies:

diff --git a/packages/lit-starter-ts/README.md b/packages/lit-starter-ts/README.md
@@ -6,6 +6,22 @@ This template is generated from the `lit-starter-ts` package in [the main Lit
 repo](https://github.com/lit/lit). Issues and PRs for this template should be
 filed in that repo.
 
+## About this release
+
+This is a pre-release of Lit 3.0, the next major version of Lit.
+
+Lit 3.0 has very few breaking changes from Lit 2.0:
+
+- Drops support for IE11
+- Published as ES2021
+- Removes a couple of deprecated Lit 1.x APIs
+
+Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
+
+Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
+
+Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
+
 ## Setup
 
 Install dependencies:

diff --git a/packages/lit/README.md b/packages/lit/README.md
@@ -20,13 +20,25 @@ Lit is a simple library for building fast, lightweight web components.
 
 At Lit's core is a boilerplate-killing component base class that provides reactive state, scoped styles, and a declarative template system that's tiny, fast and expressive.
 
-## Documentation
+## About this release
 
-See the full documentation for Lit at [lit.dev](https://lit.dev)
+This is a pre-release of Lit 3.0, the next major version of Lit.
 
-## About this release
+Lit 3.0 has very few breaking changes from Lit 2.0:
+
+- Drops support for IE11
+- Published as ES2021
+- Removes a couple of deprecated Lit 1.x APIs
+
+Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
 
-This is a stable release of Lit 2.0. If upgrading from previous versions of `lit-element` or `lit-html`, please see the [Upgrade Guide](https://lit.dev/docs/releases/upgrade/) for a step-by-step guide on upgrading.
+Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
+
+Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
+
+## Documentation
+
+See the full documentation for Lit at [lit.dev](https://lit.dev)
 
 ## Overview
 

diff --git a/packages/reactive-element/README.md b/packages/reactive-element/README.md
@@ -9,6 +9,22 @@
 
 A simple low level base class for creating fast, lightweight web components.
 
+## About this release
+
+This is a pre-release of Lit 3.0, the next major version of Lit.
+
+Lit 3.0 has very few breaking changes from Lit 2.0:
+
+- Drops support for IE11
+- Published as ES2021
+- Removes a couple of deprecated Lit 1.x APIs
+
+Lit 3.0 should require no changes to upgrade from Lit 2.0 for the vast majority of users. Once the full release is published, most apps and libraries will be able to extend their npm version ranges to include both 2.x and 3.x, like `"^2.7.0 || ^3.0.0"`.
+
+Lit 2.x and 3.0 are _interoperable_: templates, base classes, directives, decorators, etc., from one version of Lit will work with those from another.
+
+Please file any issues you find on our [issue tracker](https://github.com/lit/lit/issues).
+
 ## Documentation
 
 Full documentation is available at [lit.dev](https://lit.dev/docs/api/ReactiveElement/).