<commit_before>[![Bourbon Sass Mixin Library](http://bourbon.io/images/shared/bourbon-logo.png)](http://bourbon.io)

*This is a node-sass port of the [Bourbon](http://bourbon.io) library. If you
are looking for the original Ruby/Rails version, you can find it
[here](https://github.com/thoughtbot/bourbon).*

## Requirements
- [node](http://nodejs.org)
- [node-sass](https://github.com/andrew/node-sass)

# Installation

To install as a development dependency, run:

```bash
npm install --save-dev node-bourbon
```

If you need it for production, replace `--save-dev` with `--save`.

# Usage

The `includePaths` property returns an array of paths for use in
node-sass' `includePaths` option.

```javascript
var bourbon = require('node-bourbon').includePaths;
```

You can then use this array in your options:

```javascript
var sass    = require('node-sass')
  , bourbon = require('node-bourbon').includePaths;

var paths = ['other/path', 'another/path'].concat(bourbon);

sass.render({
  file: './application.scss',
  success: function(css){
    console.log(css);
  },
  error: function(error) {
    console.log(error);
  },
  includePaths: paths,
  outputStyle: 'compressed'
});
```

Import Bourbon at the beginning of your main scss file.
All additional stylesheets must be imported below Bourbon:

```scss
@import "bourbon";
@import "other/scss/partial";
```

# Grunt Usage

Using the [grunt-sass](https://github.com/sindresorhus/grunt-sass) task:

```javascript
grunt.initConfig({
  sass: {
    dist: {
      options: {
        includePaths: require('node-bourbon').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});
```

Using the [grunt-contrib-sass](https://github.com/gruntjs/grunt-contrib-sass) task:

```javascript
grunt.initConfig({
  sass: {
    dist: {
      options: {
        loadPath: require('node-bourbon').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});
```

# Testing

```
make test
```

Credits
-------

This node-sass port is maintained by <NAME>, however all credits for
the Bourbon library go to [thoughtbot, inc](http://thoughtbot.com/community):

> ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
>
> Bourbon is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
>
> The names and logos for thoughtbot are trademarks of thoughtbot, inc.
>
> Got questions? Need help? Tweet at [@phillapier](http://twitter.com/phillapier).

License
-------

node-bourbon is Copyright © 2013 <NAME>. It is free software, and may be redistributed under the terms specified in the LICENSE file.<commit_msg>add travis-ci badge; update readme<commit_after>[![Bourbon Sass Mixin Library](http://bourbon.io/images/shared/bourbon-logo.png)](http://bourbon.io)

*This is a node-sass port of the [Bourbon](http://bourbon.io) library. If you
are looking for the original Ruby/Rails version, you can find it
[here](https://github.com/thoughtbot/bourbon).*

[![Build Status](https://travis-ci.org/lacroixdesign/node-bourbon.png?branch=master)](https://travis-ci.org/lacroixdesign/node-bourbon)

# Requirements
- [node](http://nodejs.org)
- [node-sass](https://github.com/andrew/node-sass)

# Installation

To install as a development dependency, run:

```bash
npm install --save-dev node-bourbon
```

If you need it in production, replace `--save-dev` with `--save`.

# Usage

The `includePaths` property returns an array of paths for use in
node-sass' `includePaths` option.

```javascript
var bourbon = require('node-bourbon').includePaths;
```

You can then pass this array to your config options:

```javascript
var sass    = require('node-sass')
  , bourbon = require('node-bourbon').includePaths;

sass.render({
  file: './application.scss',
  success: function(css){
    console.log(css);
  },
  error: function(error) {
    console.log(error);
  },
  // If you have additional paths to include, do something like:
  // includePaths: bourbon.concat('other/path', 'another/path'),
  includePaths: bourbon,
  outputStyle: 'compressed'
});
```

Import Bourbon at the beginning of your main scss file:

```scss
@import "bourbon";
@import "other/scss/partial";
```

# Grunt Usage

### Using the grunt-sass task

The [grunt-sass](https://github.com/sindresorhus/grunt-sass) task uses
[node-sass](https://github.com/andrew/node-sass)
([libsass](https://github.com/hcatlin/libsass)) underneath, and is the recommended
way to use Grunt with node-bourbon.

Example config:

```javascript
grunt.initConfig({
  sass: {
    dist: {
      options: {
        includePaths: require('node-bourbon').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});
```

### Using the grunt-contrib-sass task

If you are using the Ruby version of Sass with node-bourbon, then you will need to use
the [grunt-contrib-sass](https://github.com/gruntjs/grunt-contrib-sass) task instead.

*Note that node-bourbon isn't tested against the Ruby version, however some dirty*
*testing showed that it should work with v3.2 and 3.3.0.rc.2 of the gem. YMMV.*

Example config:

```javascript
grunt.initConfig({
  sass: {
    dist: {
      options: {
        loadPath: require('node-bourbon').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});
```

# Testing

```
make test
```

Credits
-------

This node-sass port is maintained by <NAME>, however all credits for
the Bourbon library go to [thoughtbot, inc](http://thoughtbot.com/community):

> ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
>
> Bourbon is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
>
> The names and logos for thoughtbot are trademarks of thoughtbot, inc.
>
> Got questions? Need help? Tweet at [@phillapier](http://twitter.com/phillapier).

License
-------

node-bourbon is Copyright © 2013-2014 <NAME>. It is free software, and may be redistributed under the terms specified in the LICENSE file.
{'fraction_non_alphanumeric': 0.1517561298873426, 'fraction_numerical': 0.002982107355864811, 'mean_word_length': 3.7017133956386292, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 21, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4058418', 'n_tokens_mistral': 2070, 'n_tokens_neox': 1977, 'n_words': 533}