mirror of
https://github.com/jakejarvis/stitches-normalize.git
synced 2025-04-26 12:06:11 -04:00
add usage example to readme
This commit is contained in:
parent
6e5fb6144b
commit
b3aa918c6a
38
README.md
38
README.md
@ -1,8 +1,42 @@
|
||||
# 🧵 stitches-normalize
|
||||
|
||||
**🚧 Work in progress!**
|
||||
[](https://www.npmjs.com/package/stitches-normalize)
|
||||
[](LICENSE)
|
||||
|
||||
@sindresorhus's [modern-normalize.css](https://github.com/sindresorhus/modern-normalize) as a plug-and-play JavaScript object compatible with Stitches.
|
||||
@sindresorhus's [**modern-normalize.css**](https://github.com/sindresorhus/modern-normalize) as a plug-and-play JavaScript object compatible with Stitches.
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install stitches-normalize
|
||||
# or...
|
||||
yarn add stitches-normalize
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
This assumes you already have a `stitches.config.js` (or `.ts`) file that re-exports the `globalCss()` function generated by `createStitches()`.
|
||||
|
||||
You can read more about setting that file up [in Stitches' awesome documentation](https://stitches.dev/docs/installation#create-your-config-file).
|
||||
|
||||
```jsx
|
||||
import { globalCss } from "./stitches.config";
|
||||
import normalizeCss from "stitches-normalize";
|
||||
|
||||
const globalStyles = globalCss(...normalizeCss, {
|
||||
// you can put the rest of your global styles here if necessary.
|
||||
// these rules will override stitches-normalize's.
|
||||
|
||||
body: {
|
||||
fontFamily: "'Comic Sans MS', sans-serif",
|
||||
},
|
||||
});
|
||||
|
||||
const App = () => {
|
||||
globalStyles();
|
||||
return <h1>Hello, normalized world!</h1>;
|
||||
};
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user