<commit_before>##SUCCSS, a CSS Regression testing tool
###Turn your CSS designs into successful integrations.

Full documentation at: [succss.ifzenelse.net][7]

####Install:
```
npm install -g succss
```


####Configure:
```
// your-conf.js
Succss.pages = {
  'any webpage': {
    url:'succss.ifzenelse.net',
    directory:'./screenshots',
    captures: {
      // Key:name Value:CSS selector.
      'header':'header',
      'square1':'#red.color-square',
      'square2':'#green.color-square',
      'square3':'#blue.color-square'
    },
  },
  'another one': { 
    ... 
  }
};

Succss.viewports: {
  'classic wide': {
    width: 1366,
    height: 768
  },
  'mobile': {
    width: 320,
    height: 480
  },
  ...
}
```

####Run:
```
succss add your-conf.js
```


####Check updates against added references:
```
succss check your-conf.js
```


####Do you need more infos ?

- [Installation troubleshooting][1]
- [Advanced Configuration][2]
- [Succss from the CLI][3]
- [Custom validations][4]
- [Why another CSS Regression Testing tool ?][5]
- [Fork Succss !][6]
- [Typical use cases][0]
- --[Home page][7]

[0]:http://succss.ifzenelse.net/usecases
[1]:http://succss.ifzenelse.net/installation
[2]:http://succss.ifzenelse.net/configuration
[3]:http://succss.ifzenelse.net/commandline
[4]:http://succss.ifzenelse.net/customize
[5]:http://succss.ifzenelse.net/why
[6]:http://succss.ifzenelse.net/fork
[7]:http://succss.ifzenelse.net/home<commit_msg>Updates README.md<commit_after>##SUCCSS, a CSS Regression testing tool
###Turn your CSS designs into successful integrations.

Full documentation at: [succss.ifzenelse.net][7]

![small diff image example][12]

####Install:
```
npm install -g succss
```

####Configure:
```
// data.js
Succss.pages = {
  'home': {
    url:'succss.ifzenelse.net/home',
    directory:'screenshots/dir',
    // captures: { 'name' : 'CSS selector' }
    captures: {
      // leave an empty value if selector == name
      'header':'',
      'dynamic-text':'body #header-text > #static-line + span',
      ...
    },
  },
  'another-page': {
    ...
  }
};

Succss.viewports = {
  // './screenshots/dir/home--header--1366x768.png' file
  // './screenshots/dir/home--dynamic-text--1366x768.png' file
  'default': {
    width: 1366,
    height: 768
  },
  // './screenshots/dir/home--header--640x480.png' file
  // './screenshots/dir/home--dynamic-text--640x480.png' file
  'mobile-landscape': {
    width: 640,
    height: 480
  },
  ...
}
```

####Run:
```
succss add your-conf.js
```


####Check updates against added references:
```
succss check your-conf.js
```


####Do you need more infos ?

- [Installation troubleshooting][1]
- [Advanced Configuration][2]
- [Succss from the CLI][3]
- [Custom validations][4]
- [Why another CSS Regression Testing tool ?][5]
- [Fork Succss !][6]
- [Typical use cases][0]
- --[Home page][7]

![large diff image example][8]

####Built with:
- [CasperJS][9]
- [Imagediff][10]
- [ResembleJS][11]
- MIT Licenses

[0]:http://succss.ifzenelse.net/usecases
[1]:http://succss.ifzenelse.net/installation
[2]:http://succss.ifzenelse.net/configuration
[3]:http://succss.ifzenelse.net/commandline
[4]:http://succss.ifzenelse.net/customize
[5]:http://succss.ifzenelse.net/why
[6]:http://succss.ifzenelse.net/fork
[7]:http://succss.ifzenelse.net/home
[8]:https://raw.githubusercontent.com/B2F/Succss-doc/master/img/screenshots/large-diff.jpeg
[9]:http://casperjs.org/
[10]:http://humblesoftware.github.io/js-imagediff/
[11]:http://huddle.github.io/Resemble.js/
[12]:https://raw.githubusercontent.com/B2F/Succss-doc/master/img/screenshots/small-diff.jpeg
{'fraction_non_alphanumeric': 0.20144284128745837, 'fraction_numerical': 0.029689234184239733, 'mean_word_length': 3.5632911392405062, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 2, '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': '4054654', 'n_tokens_mistral': 1466, 'n_tokens_neox': 1342, 'n_words': 236}