Skip to content

Peer deps #12

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

Merged
merged 3 commits into from
Aug 9, 2015
Merged
Show file tree
Hide file tree
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
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ Automatically compiles a CSS Module to a low-level interchange format called ICS

One of the ways you can compile [CSS Modules](https://github.com/css-modules/css-modules) to the ICSS format is through the require hook. The require hook will bind itself to node's require and automatically compile files on the fly. This is similar to Babel's [babel/register](https://babeljs.io/docs/usage/require/).

## Requirements

To use this tool we require postcss and few plugins to be installed on your project. See the list below:

- `"postcss": "4.x"`
- `"postcss-modules-extract-imports": "0.x"`
- `"postcss-modules-local-by-default": "0.x"`
- `"postcss-modules-scope": "0.x"`

## Install

```bash
Expand Down
16 changes: 10 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@
"version": "1.0.1",
"description": "A require hook to compile CSS Modules on the fly",
"main": "index.js",
"dependencies": {
"postcss": "^4.1.16",
"postcss-modules-extract-imports": "0.0.5",
"postcss-modules-local-by-default": "0.0.9",
"postcss-modules-scope": "0.0.8"
},
"devDependencies": {
"babel": "^5.8.20",
"babel-eslint": "^4.0.5",
Expand All @@ -20,8 +14,18 @@
"in-publish": "^2.0.0",
"isparta": "^3.0.3",
"mocha": "^2.2.5",
"postcss": "4.x",
"postcss-modules-extract-imports": "0.x",
"postcss-modules-local-by-default": "0.x",
"postcss-modules-scope": "0.x",
"precommit-hook": "^3.0.0"
},
"peerDependencies": {
"postcss": "4.x",
"postcss-modules-extract-imports": "0.x",
"postcss-modules-local-by-default": "0.x",
"postcss-modules-scope": "0.x"
},
"scripts": {
"start": "esw -w .",
"lint": "eslint .",
Expand Down