Skip to content

Commit

Permalink
Update README to ensure users development will occur. (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
jthegedus authored and giuseppeg committed Nov 22, 2017
1 parent 9151f33 commit f62fd94
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Expand Up @@ -3,7 +3,8 @@
[![Build Status](https://travis-ci.org/giuseppeg/styled-jsx-plugin-postcss.svg?branch=master)](https://travis-ci.org/giuseppeg/styled-jsx-plugin-postcss)
[![npm](https://img.shields.io/npm/v/styled-jsx-plugin-postcss.svg)](https://www.npmjs.com/package/styled-jsx-plugin-postcss)

Use [PostCSS](https://github.com/postcss/postcss) with [styled-jsx](https://github.com/zeit/styled-jsx) 💥
Use [PostCSS](https://github.com/postcss/postcss) with
[styled-jsx](https://github.com/zeit/styled-jsx) 💥

## Usage

Expand All @@ -13,27 +14,33 @@ Install the package first.
npm install --save styled-jsx-plugin-postcss
```

Next, add `styled-jsx-plugin-postcss` to the `styled-jsx`'s `plugins` in your babel configuration:
Next, add `styled-jsx-plugin-postcss` to the `styled-jsx`'s `plugins` in your
babel configuration:

```json
{
"plugins": [
[
"styled-jsx/babel",
{ "plugins": ["styled-jsx-plugin-postcss"] }
]
["styled-jsx/babel", { "plugins": ["styled-jsx-plugin-postcss"] }]
]
}
```

#### Notes

`styled-jsx-plugin-postcss` uses `styled-jsx`'s plugin system which is supported from version 2.
Read more on their repository for further info.
`styled-jsx-plugin-postcss` uses `styled-jsx`'s plugin system which is supported
from version 2. Read more on their repository for further info.

## Plugins

`styled-jsx-plugin-postcss` uses [`postcss-load-plugins`](https://www.npmjs.com/package/postcss-load-plugins) therefore you may want to refer to their docs to learn more about [adding plugins](https://www.npmjs.com/package/postcss-load-plugins#packagejson)
`styled-jsx-plugin-postcss` uses
[`postcss-load-plugins`](https://www.npmjs.com/package/postcss-load-plugins)
therefore you may want to refer to their docs to learn more about
[adding plugins](https://www.npmjs.com/package/postcss-load-plugins#packagejson).

## Contributions

Although a _Proof Of Concept_ plugin, **PRs and contributions are welcome!** We
aim to drive development of this plugin through community contributions.

## License

Expand Down

0 comments on commit f62fd94

Please sign in to comment.