Skip to content

Commit 87cae5d

Browse files
authored
Update README (#2538)
* updating README to reflect maintenance mode * linting README
1 parent c1f2bf4 commit 87cae5d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Introducing Web Awesome
1+
# Shoelace is now Web Awesome 🧡!
22

3-
Web Awesome is the new name for Shoelace, and version 3 is now in beta! [Come check it out!](https://webawesome.com/) 🧡
3+
> [!IMPORTANT]
4+
> **Shoelace is in maintenance mode (LTS)**. It is no longer actively being developed but remains available for use under the MIT license. Critical fixes may be released as needed; there is no fixed end date.
5+
> For active development and new features, check out Web Awesome at [https://webawesome.com](https://webawesome.com) and [https://github.com/shoelace-style/webawesome](https://github.com/shoelace-style/webawesome).
46
5-
**Heads up!** Most of the project's activity is now happening [in the new repo](https://github.com/shoelace-style/webawesome).
7+
Web Awesome has an even larger library of free web [components](https://webawesome.com/docs/components/), plus [themes](https://webawesome.com/docs/themes/), [utilities](https://webawesome.com/docs/utilities/), [patterns](https://webawesome.com/docs/patterns/), and more.
68

79
---
810

@@ -19,11 +21,9 @@ A forward-thinking library of web components.
1921

2022
---
2123

22-
Documentation: [shoelace.style](https://shoelace.style)
23-
24-
Source: [github.com/shoelace-style/shoelace](https://github.com/shoelace-style/shoelace)
25-
26-
Twitter: [@shoelace_style](https://twitter.com/shoelace_style)
24+
- Documentation: [shoelace.style](https://shoelace.style)
25+
- Shoelace Source (Maintenance Mode - LTS): [github.com/shoelace-style/shoelace](https://github.com/shoelace-style/shoelace)
26+
- Web Awesome Source (Active Development): [github.com/shoelace-style/webawesome](https://github.com/shoelace-style/webawesome)
2727

2828
---
2929

@@ -57,7 +57,7 @@ Once you've cloned the repo, run the following command.
5757
npm start
5858
```
5959

60-
This will spin up the dev server. After the initial build, a browser will open automatically. There is currently no hot module reloading (HMR), as browser's don't provide a way to reregister custom elements, but most changes to the source will reload the browser automatically.
60+
This will spin up the dev server. After the initial build, a browser will open automatically. There is currently no hot module reloading (HMR), as browsers don't provide a way to reregister custom elements, but most changes to the source will reload the browser automatically.
6161

6262
### Building
6363

@@ -79,7 +79,7 @@ This will generate a source file, a stylesheet, and a docs page for you. When yo
7979

8080
### Contributing
8181

82-
Shoelace is an open source project and contributions are encouraged! If you're interesting in contributing, please review the [contribution guidelines](CONTRIBUTING.md) first.
82+
Shoelace is open source under the MIT license. Bug fixes and maintenance updates may still be considered; for new features and active development, see [Web Awesome](https://webawesome.com). If you want to contribute here, please review the [contribution guidelines](CONTRIBUTING.md) first.
8383

8484
## License
8585

0 commit comments

Comments
 (0)