Skip to content

Commit 3820e2d

Browse files
committed
docs: update README files to include badges for CI, coverage, and license information
1 parent 6b38c4b commit 3820e2d

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# ⚡ LightningCSS Plugins
22

3+
[![CI](https://github.com/felixicaza/lightningcss-plugins/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/felixicaza/lightningcss-plugins/actions/workflows/test.yml)
4+
[![Coveralls](https://img.shields.io/coverallsCoverage/github/felixicaza/lightningcss-plugins?logo=coveralls&link=https%3A%2F%2Fcoveralls.io%2Fgithub%2Ffelixicaza%2Flightningcss-plugins)](https://coveralls.io/github/felixicaza/lightningcss-plugins)
5+
[![GitHub License](https://img.shields.io/github/license/felixicaza/lightningcss-plugins)](https://github.com/felixicaza/lightningcss-plugins/blob/main/LICENSE)
6+
37
This repository is dedicated to housing a collection of plugins for [LightningCSS](https://lightningcss.dev), a powerful and efficient CSS processor.
48

59
## 📖 Introduction
@@ -10,7 +14,7 @@ This repository is dedicated to housing a collection of plugins for [LightningCS
1014

1115
This repository currently includes the following packages:
1216

13-
- **[pxtorem](packages/pxtorem)**: A plugin to convert pixel units to rem units in your CSS.
17+
- **[<img src="https://img.shields.io/badge/v0.0.7-4ea91d" alt="version" align="center"> pxtorem](packages/pxtorem)**: A plugin to convert pixel units to rem units in your CSS.
1418

1519
Each plugin is located in the [`packages`](packages) directory to follow a consistent structure for ease development and maintenance.
1620

packages/pxtorem/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# ⚡ lightningcss-plugin-pxtorem
22

3+
[![GitHub Release](https://img.shields.io/github/v/release/felixicaza/lightningcss-plugins?logo=npm)](https://www.npmjs.com/package/lightningcss-plugin-pxtorem)
4+
[![CI](https://github.com/felixicaza/lightningcss-plugins/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/felixicaza/lightningcss-plugins/actions/workflows/test.yml)
5+
[![Coveralls](https://img.shields.io/coverallsCoverage/github/felixicaza/lightningcss-plugins?logo=coveralls&link=https%3A%2F%2Fcoveralls.io%2Fgithub%2Ffelixicaza%2Flightningcss-plugins)](https://coveralls.io/github/felixicaza/lightningcss-plugins)
6+
[![GitHub License](https://img.shields.io/github/license/felixicaza/lightningcss-plugins)](https://github.com/felixicaza/lightningcss-plugins/blob/main/LICENSE)
7+
38
The `lightningcss-plugin-pxtorem` plugin is designed to convert pixel units to rem units in your CSS, making it easier to maintain responsive and scalable designs.
49

510
## ✨ Features
@@ -137,16 +142,16 @@ h1 {
137142
}
138143
```
139144

140-
See others examples in the [test folder](./test/).
145+
See others examples in the [test folder](https://github.com/felixicaza/lightningcss-plugins/blob/main/packages/pxtorem/test/index.test.ts).
141146

142147
## 🤝 Contributing
143148

144-
If you wish to contribute to this project, you can do so by reading the [contribution guide](../../CONTRIBUTING.md).
149+
If you wish to contribute to this project, you can do so by reading the [contribution guide](https://github.com/felixicaza/lightningcss-plugins/blob/main/CONTRIBUTING.md).
145150

146151
## 🙌 Credits
147152

148153
This plugin was highly inspired by [postcss-pxtorem](https://github.com/cuth/postcss-pxtorem).
149154

150155
## 📄 License
151156

152-
This project is licensed under the MIT License. See the [license file](../../LICENSE) for more details.
157+
This project is licensed under the MIT License. See the [license file](https://github.com/felixicaza/lightningcss-plugins/blob/main/LICENSE) for more details.

0 commit comments

Comments
 (0)