Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
eGavr committed Sep 3, 2014
1 parent 3bc6125 commit fafb26a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# css-minimizers-benchmark
# css-minimizers-benchmark (CMB)

Сompares the work of **CSS** minimizers.

Expand Down Expand Up @@ -38,7 +38,7 @@ $ bin/compare-minimizers

### How to configure paths?

Go to the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/lib/config.js#L19). In this file you can configure paths with the help of these variables:
Go to the [configuration file](https://github.com/eGavr/css-minimizers-benchmark/blob/master/.cmb/config.js#L20). In this file you can configure paths with the help of these variables:

* `toRawCSS` - path to tests (raw, not minimized **CSS** files).
* `toMinCSS` - path where to output minimized **CSS** files.
Expand All @@ -48,7 +48,7 @@ Go to the [configuration file](https://github.com/eGavr/css-minimizers-bench/blo

**1**. Go to the [package.json](https://github.com/eGavr/css-minimizers-bench/blob/master/package.json#L27) and add your minimizer to the dependencies.

**2**. Go to the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/lib/config.js#L8) and add your code according to the following template:
**2**. Go to the [configuration file](https://github.com/eGavr/css-minimizers-benchmark/blob/master/.cmb/config.js#L9) and add your code according to the following template:

```js
name: minimize(require('module'), 'method')
Expand All @@ -70,7 +70,7 @@ npm install

### How to add your archiver?

**1**. Go to the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/lib/config.js#L15) and add your code according to the following template:
**1**. Go to the [configuration file](https://github.com/eGavr/css-minimizers-benchmark/blob/master/.cmb/config.js#L16) and add your code according to the following template:

```js
name: archive('bash script', 'suffix')
Expand All @@ -79,8 +79,8 @@ name: archive('bash script', 'suffix')
where:
* `name` - the name of your archiver (it will be used in the log).
* `bash script` which archives the file. This script provides several **keywords**:
* `[FILE_PATH]` will be replaced with the paths of all files which were minimized by all specified in the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/lib/config.js#L8) minimizers.
* `[TO_ARCH_CSS]` will be replaced with the path which you have specified in variable `paths.toArchCSS` in the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/lib/config.js#L22).
* `[FILE_PATH]` will be replaced with the paths of all files which were minimized by all specified in the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/.cmb/config.js#L9) minimizers.
* `[TO_ARCH_CSS]` will be replaced with the path which you have specified in variable `paths.toArchCSS` in the [configuration file](https://github.com/eGavr/css-minimizers-bench/blob/master/.cmb/config.js#L23).
* `suffix` which is added to a file by the archiver.

**2**. See the [usage](https://github.com/eGavr/css-minimizers-bench#usage).
Expand Down

0 comments on commit fafb26a

Please sign in to comment.