From 70e1b129d54e25329540fa52346ce2a25fbff59a Mon Sep 17 00:00:00 2001 From: everdimension Date: Sat, 16 Feb 2019 16:25:39 +0300 Subject: [PATCH] Update README: add install instructions I almost always check the docs for install instructions since not all libs go by the same name in the `npm` registry. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 27509ebb..719c3690 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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`