Skip to content

Commit 7326280

Browse files
authored
docs: polish README (#464)
1 parent 4ac5d4b commit 7326280

File tree

1 file changed

+49
-15
lines changed

1 file changed

+49
-15
lines changed

README.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,6 @@
1414

1515
Rslib is a library development tool that leverages the well-designed configurations and plugins of [Rsbuild](https://rsbuild.dev), empowering library developers to take advantage of the extensive knowledge and ecosystem of webpack and Rspack.
1616

17-
Rslib provides a comprehensive set of build features for library development, including:
18-
19-
- **Compilation of diverse languages**: TypeScript, JSX, Sass, Less, CSS Modules, Wasm, and more.
20-
- **Flexible build modes**: Bundle and bundleless options to meet varying needs.
21-
- **Multiple output formats**: ESM, CJS, and UMD for maximum compatibility.
22-
- **Declaration file generation**: Including isolated declarations.
23-
- **Advanced features**: Module Federation, asset compression, PostCSS, Lightning CSS, and more.
24-
2517
## ✨ Why Rslib?
2618

2719
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, the community has developed a vast ecosystem around webpack and Rspack, which provides powerful features like tree shaking, code splitting, module federation and more.
@@ -30,20 +22,26 @@ So we decided to create Rslib. It improves the quality of ESM output from Rspack
3022

3123
![](https://assets.rspack.dev/rsbuild/assets/rspack-stack-layers.png)
3224

33-
## 📍 Roadmap
34-
35-
🚧 Rslib is still in its early stages and under active development. We are building Rslib by working in two main parts:
25+
Rslib is still in its early stages and under active development. We are building Rslib by working in two main parts:
3626

3727
- [bundler support track](https://github.com/web-infra-dev/rslib/issues/45): Improve the quality of ESM / CJS outputs by contributing to Rspack and webpack.
3828
- [Rslib features track](https://github.com/web-infra-dev/rslib/issues/46): Develop the core features of Rslib.
3929

40-
> You can click the link above to check the progress of these tasks. The roadmap may change as we move forward.
30+
The roadmap may change as we move forward.
31+
32+
## 🔥 Features
33+
34+
Rslib has the following features:
4135

42-
We plan to complete the core features of Rslib in Q3 2024 and use Rslib to build our npm packages such as Rspack and Rsbuild (dogfooding). And Rslib will have a public stable version in Q4 2024.
36+
- **Compilation of diverse languages**: TypeScript, JSX, Sass, Less, CSS Modules, Wasm, and more.
37+
- **Flexible build modes**: Bundle and bundleless options to meet varying needs.
38+
- **Multiple output formats**: ESM, CJS, and UMD for maximum compatibility.
39+
- **Declaration file generation**: Including isolated declarations.
40+
- **Advanced features**: Module Federation, asset compression, PostCSS, Lightning CSS, and more.
4341

44-
If you're interested in Rslib, feel free to submit issues or pull requests to help us get there faster.
42+
## 📚 Getting Started
4543

46-
You can also clone the repository and run the examples in the [examples](https://github.com/web-infra-dev/rslib/tree/main/examples) folder to experience Rslib.
44+
To get started with Rslib, see the [Quick Start](https://lib.rsbuild.dev/guide/start/quick-start).
4745

4846
## 🦀 Links
4947

@@ -74,6 +72,40 @@ Please read the [Contributing Guide](https://github.com/web-infra-dev/rslib/blob
7472
<img src="https://contrib.rocks/image?repo=web-infra-dev/rslib&columns=16&max=96"><br/><br/>
7573
</th>
7674
</tr>
75+
<tr>
76+
<td>
77+
<picture>
78+
<source
79+
media="(prefers-color-scheme: dark)"
80+
srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active&period=past_90_days&owner_id=87694465&repo_ids=766839449&image_size=2x3&color_scheme=dark"
81+
/>
82+
<img
83+
alt="Contributors of web-infra-dev/rslib"
84+
src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active&period=past_90_days&owner_id=87694465&repo_ids=766839449&image_size=2x3&color_scheme=light"
85+
/>
86+
</picture>
87+
</td>
88+
<td rowspan="2">
89+
<picture>
90+
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=766839449&image_size=4x7&color_scheme=dark">
91+
<img alt="New trends of web-infra-dev" src="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=766839449&image_size=4x7&color_scheme=light">
92+
</picture>
93+
</td>
94+
</tr>
95+
<tr>
96+
<td>
97+
<picture>
98+
<source
99+
media="(prefers-color-scheme: dark)"
100+
srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=766839449&image_size=2x3&color_scheme=dark"
101+
/>
102+
<img
103+
alt="Contributors of web-infra-dev/rslib"
104+
src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=766839449&image_size=2x3&color_scheme=light"
105+
/>
106+
</picture>
107+
</td>
108+
</tr>
77109
</table>
78110
</a>
79111

@@ -96,6 +128,8 @@ Some of the implementations of Rslib have drawn inspiration from outstanding pro
96128
- [esbuild](https://github.com/evanw/esbuild), created by [Evan Wallace](https://github.com/evanw).
97129
- [tsup](https://github.com/egoist/tsup), created by [EGOIST](https://github.com/egoist).
98130

131+
This Rslib website is powered by [Netlify](https://www.netlify.com/).
132+
99133
## 📖 License
100134

101135
Rslib is licensed under the [MIT License](https://github.com/web-infra-dev/rslib/blob/main/LICENSE).

0 commit comments

Comments
 (0)