diff --git a/README.md b/README.md index 00f845c..24e2a6b 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,32 @@ [![NPM Version](https://img.shields.io/npm/v/solid-styled-jsx.svg?style=flat)](https://www.npmjs.com/package/solid-styled-jsx) ![](https://img.shields.io/npm/dm/solid-styled-jsx.svg?style=flat) -This library is a wrapper to allow you to use Solid with Zeit's [styled-jsx](https://github.com/zeit/styled-jsx). It accomplishes this by using a babel transform to change the Style JSX element import to use Solid's version. From there simply add the plugin `solid-styled-jsx/babel` to your babel config and you are good to go. The plugin accepts the same options as it's `styled-jsx/babel` counterpart. +This library is a wrapper to allow you to use Solid with Zeit's [styled-jsx](https://github.com/zeit/styled-jsx). It accomplishes this by using a babel transform to change the Style JSX element import to use Solid's version. -**Note: SSR not supported yet** -**Note: Does not work with Create Solid App** +> **Warning** +> +> SSR not supported yet. +> +> Does not work with Create Solid App yet. + +## Install + +Note that `solid-jsx` is a peer dependency, so it has to be installed too: + +```sh +npm install solid-styled-jsx styled-jsx +``` + +From there simply add the plugin `solid-styled-jsx/babel` to your babel config, + +```js +module.export = { + presets: ['babel-preset-solid'], + plugins: ['solid-styled-jsx/babel'], +} +``` + +and you are good to go. The plugin accepts the same options as it's `styled-jsx/babel` counterpart. ## Typescript