Skip to content
This repository was archived by the owner on Sep 17, 2018. It is now read-only.

Commit 8081200

Browse files
committed
replace stub options docs with actual docs of available options
1 parent 48caf1d commit 8081200

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,46 +38,50 @@ grunt.initConfig({
3838

3939
### Options
4040

41-
#### options.separator
42-
Type: `String`
43-
Default value: `', '`
41+
All options are passed directly to css-flip's `flip()` function.
42+
None of the options are required.
43+
44+
#### options.compress
45+
Type: `Boolean`
46+
Default value: `false`
4447

45-
A string value that is used to do something with whatever.
48+
Whether to slightly compress output. Some newlines and indentation are removed. Comments stay intact.
4649

47-
#### options.punctuation
50+
#### options.indent
4851
Type: `String`
49-
Default value: `'.'`
52+
Default value: `' '` (two spaces)
5053

51-
A string value that is used to do something else with whatever else.
54+
String value to use for 1 level of indentation in the output.
5255

5356
### Usage Examples
5457

5558
#### Default Options
56-
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`
59+
In this example, two CSS files are flipped using css-flip's default settings.
5760

5861
```js
5962
grunt.initConfig({
6063
css_flip: {
6164
options: {},
6265
files: {
63-
'dest/default_options': ['src/testing', 'src/123'],
66+
'flipped-one.css': 'original-one.css',
67+
'flipped-two.css': 'original-two.css'
6468
},
6569
},
6670
});
6771
```
6872

6973
#### Custom Options
70-
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`
74+
In this example, the resulting flipped CSS files will also be slightly compressed using css-flip's `compress` option.
7175

7276
```js
7377
grunt.initConfig({
7478
css_flip: {
7579
options: {
76-
separator: ': ',
77-
punctuation: ' !!!',
80+
compress: true
7881
},
7982
files: {
80-
'dest/default_options': ['src/testing', 'src/123'],
83+
'flipped-one.min.css': 'original-one.css',
84+
'flipped-two.min.css': 'original-two.css'
8185
},
8286
},
8387
});

0 commit comments

Comments
 (0)