Skip to content

Commit 10183a9

Browse files
committed
Update readme
1 parent a21ba2e commit 10183a9

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,52 @@
22

33
![Build Status](https://github.com/css-doodle/postcss-doodle/actions/workflows/ci.yml/badge.svg)
44
![license](https://img.shields.io/github/license/mashape/apistatus.svg)
5+
6+
7+
[PostCSS] plugin to use generators from [css-doodle] with the same syntax.
8+
9+
[PostCSS]: https://github.com/postcss/postcss
10+
[css-doodle]: https://github.com/css-doodle
11+
[@shape]: https://yuanchuan.dev/polygon-shapes
12+
[@svg]: https://yuanchuan.dev/experimenting-a-new-syntax-to-write-svg
13+
14+
15+
## Installation
16+
17+
```bash
18+
npm i -D postcss-doodle
19+
```
20+
21+
## Usage
22+
23+
```js
24+
postcss([ require('postcss-doodle') ])
25+
```
26+
27+
28+
## Supported functions
29+
30+
### [@svg]
31+
32+
```css
33+
background: @svg(
34+
viewBox: -5 -5 10 10;
35+
circle {
36+
r: 5;
37+
fill: deeppink;
38+
}
39+
)
40+
```
41+
42+
### [@shape]
43+
44+
```css
45+
clip-path: @shape(
46+
points: 5;
47+
turn: 2;
48+
)
49+
```
50+
51+
## TODO
52+
53+
* @doodle

0 commit comments

Comments
 (0)