Skip to content

Commit 82aa47b

Browse files
fi3eworkchenjiahan
andauthored
docs: update README (#54)
Co-authored-by: neverland <[email protected]>
1 parent 4c4d4bd commit 82aa47b

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,25 @@
55
# Rslib
66

77
<p>
8-
<a href="https://discord.gg/FQfm7VqU"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat-square&logo=discord&colorA=564341&colorB=EDED91" alt="discord channel" /></a>
9-
<a href="https://github.com/web-infra-dev/rslib/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a>
8+
<a href="https://discord.gg/FQfm7VqU"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat-square&logo=discord&colorA=564341&colorB=F8F5FF" alt="Discord channel" /></a>
9+
<a href="https://github.com/web-infra-dev/rslib/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=F8F5FF" alt="license" /></a>
1010
</p>
1111

12-
Rslib is a Rsbuild-based library build tool that offers tree-shaking friendly ESM output, minimizes additional runtime code, and supports CommonJS and dts output.
12+
Rslib is a library build tool powered by [Rsbuild](https://rsbuild.dev). It allows package developers to leverage Rspack knowledge and its ecosystem. Rslib is built on top of Rsbuild's excellent configurations and plugins, ensuring optimal ESM output quality.
1313

14-
When you use Rslib to build a library, you can reuse any webpack loader, as well as webpack plugins, Rspack plugins, and Rsbuild plugins.
14+
Rslib provides out-of-the-box configurations for library development, including compilation of TypeScript, JSX, Sass, Less, CSS Modules, and Wasm, supporting Module Federation, image compression, type checking, PostCSS, and Lightning CSS.
1515

16-
This means that the build infrastructure for building web applications and libraries is consistent, and the ecosystem can be reused.
17-
18-
> Rslib is still in its early stages and under active development. It will be available in October 2024.
16+
> !NOTE
17+
> 🚧 Rslib is still in its early stages and under active development. It will be available in October 2024.
1918
> You can check some available [examples](https://github.com/web-infra-dev/rslib/tree/main/examples) in the repository.
2019
21-
## 🔥 Features
20+
## ✨ Why Rslib?
21+
22+
In the past, we typically did not use webpack or Rspack to build ESM packages because they often included excessive runtime code, making them less friendly to package consumers. However, we have developed a vast ecosystem around webpack and Rspack, which provides powerful features like tree shaking, code splitting, and module federation. So we decided to create Rslib. This tool improves the quality of ESM output from Rspack and webpack, leverages their extensive ecosystem, and utilizes Rsbuild's excellent out-of-the-box configuration. Rslib aims to provide a superior developer experience and explore new possibilities based on the Rspack architecture.
23+
24+
## 📍 Roadmap
2225

23-
WIP
26+
We have roadmap for [features track](https://github.com/web-infra-dev/rslib/issues/46) and [bundler support track](https://github.com/web-infra-dev/rslib/issues/45). You can view the project's progress there. The roadmap may change as we move forward.
2427

2528
## 🦀 Links
2629

@@ -53,8 +56,8 @@ Come and chat with us on [Discord](https://discord.gg/FQfm7VqU)! The Rstack team
5356

5457
Some of the implementations of Rslib have drawn inspiration from outstanding projects in the community. We would like to express our gratitude to them:
5558

56-
- [esbuild](https://github.com/evanw/esbuild), created by [Evan Wallace](https://github.com/evanw)
57-
- [tsup](https://github.com/egoist/tsup), created by [EGOIST](https://github.com/egoist)
59+
- [esbuild](https://github.com/evanw/esbuild), created by [Evan Wallace](https://github.com/evanw).
60+
- [tsup](https://github.com/egoist/tsup), created by [EGOIST](https://github.com/egoist).
5861

5962
## 📖 License
6063

0 commit comments

Comments
 (0)