Skip to content

Commit

Permalink
There was no simple parsing example
Browse files Browse the repository at this point in the history
Since this library addresses the parsing of SCSS and not the processing of it, I felt it made sense that the first example should be parsing, and not processing.

I imagine this would be useful to a noob coming across this repo.
  • Loading branch information
plumpNation authored Oct 31, 2017
1 parent aece149 commit 1fad179
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@ yarn install --dev postcss-scss

## Usage

### Simple parsing example

We parse SCSS files the same way as we do vanilla CSS, except we provide
postcss-scss as the syntax object.

```js
var syntax = require('postcss-scss');

var root = postcss.parse(rawSCSS, { syntax: syntax });
```

### SCSS Transformations

The main use case of this plugin is to apply PostCSS transformations directly
Expand Down

0 comments on commit 1fad179

Please sign in to comment.