Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README: add install instructions #78

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [Keyframes and global](#keyframes-and-global)
- [With props](#with-props)
- [`as` prop](#as-prop)
- [Installation](#installation)
- [Setup](#setup)
- [Options](#options)
- [Use without webpack](#use-without-webpack)
Expand Down Expand Up @@ -349,6 +350,12 @@ const StyledFooter = styled(Footer, { allowAs: true })`
`
```

## Installation

```shell
npm install --save-dev astroturf
```

## Setup

If you want the simplest, most bare-bones setup you can use the included `css-loader` which will setup css-modules and postcss-nested. This is the minimum setup necessary to get it working. Any options passed to the loader are passed to the official webpack `css-loader`
Expand Down