diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md index 6c5ae21fd..e8e434c76 100644 --- a/docs/getting-started/overview.md +++ b/docs/getting-started/overview.md @@ -9,7 +9,7 @@ A forward-thinking library of web components. Designed in New Hampshire by [Cory LaViska](https://twitter.com/claviska). -## Quick Start 🥾 +## Quick Start Add the following code to your page. @@ -26,11 +26,11 @@ Now you have access to all of Shoelace's components! Try adding a button: See the [installation instructions](getting-started/installation.md) for more details and other ways to install Shoelace. -## New to Web Components? +## New to web components? **TL;DR** – we finally have a way to create our own HTML elements and use them in any framework we want! -Thanks to the popularity of frameworks such as Angular, Vue, and React, component-driven development has become a way of life for front-end developers. Components help us encapsulate styles and behaviors into reusable building blocks. They make a lot of sense in terms of design, development, and testing. +Thanks to the popularity of frameworks such as Angular, Vue, and React, component-driven development has become a part of our every day lives. Components help us encapsulate styles and behaviors into reusable building blocks. They make a lot of sense in terms of design, development, and testing. Unfortunately, _framework-specific_ components fail us in a number of ways: @@ -38,11 +38,13 @@ Unfortunately, _framework-specific_ components fail us in a number of ways: - Their lifespan is limited to that of the framework's ⏳ - New framework versions can lead to breaking changes, requiring substantial effort to update components 😭 -Web components solve these problems. They're [supported by all modern browsers](https://caniuse.com/#feat=custom-elementsv1), they're framework-agnostic, and they're [part of the standard](https://www.webcomponents.org/specs), so we know they'll be supported by browsers for many years to come. +Web components solve these problems. They're [supported by all modern browsers](https://caniuse.com/#feat=custom-elementsv1), they're framework-agnostic, and they're [part of the spec](https://www.webcomponents.org/specs), so we know they'll be supported for many years to come. + +This is the technology that Shoelace is built on. ## Browser Support -Components are tested to work in the last two versions of the following browsers: +Shoelace is tested in the latest two versions of the following browsers. Chrome Edge @@ -50,8 +52,9 @@ Components are tested to work in the last two versions of the following browsers Opera Safari -If you need to support IE11 or pre-Chromium Edge, this library isn't for you. Although web components can (to some degree) be polyfilled for legacy browsers, supporting them is outside the scope of this project. If you're using Shoelace in such a browser, you're gonna have a bad time. ⛷ +Critical bug fixes in earlier versions will be addressed based on their severity and impact. +If you need to support IE11 or pre-Chromium Edge, this library isn't for you. Although web components can (to some degree) be polyfilled for legacy browsers, supporting them is outside the scope of this project. If you're using Shoelace in such a browser, you're gonna have a bad time. ⛷ ## License