Skip to content
This repository was archived by the owner on Jun 24, 2024. It is now read-only.

Commit 86dd1c6

Browse files
committed
docs(readme): Fix missing headings introduced in repo upgrade
1 parent 3745855 commit 86dd1c6

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ trim_trailing_whitespace = true
1111
insert_final_newline = true
1212

1313
[{*.json,.stylelintrc,.eslintrc,.babelrc}]
14-
indent_size = 2
14+
indent_size = 2

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
A module that takes any number of css file entry points and packages them together with meta data before providing them as a readable stream.
2121

22+
## Overview
2223

2324
Given any number of css file paths, for each file path, this module will:
2425
1. fetch the file at the path
@@ -28,6 +29,7 @@ Given any number of css file paths, for each file path, this module will:
2829

2930
The module provides a readable stream of the resulting objects.
3031

32+
### Output data format
3133

3234
```js
3335
{
@@ -44,16 +46,20 @@ The module provides a readable stream of the resulting objects.
4446
}
4547
```
4648

49+
## Installation
4750

4851
```bash
4952
npm install asset-pipe-css-writer
5053
```
5154

55+
## Usage
5256

57+
### Require the writer
5358
```js
5459
const CssWriter = require('asset-pipe-css-writer')
5560
```
5661

62+
### Instantiating the writer
5763

5864
Either pass a path to a single css file:
5965
```js
@@ -65,6 +71,7 @@ Or pass an array of paths to css files:
6571
const writer = new CssWriter(['/path/to/css/file1.css', '/path/to/css/file2.css'])
6672
```
6773

74+
### Consuming content from the writer
6875

6976
The writer is a readable stream in object mode so in order to access the data you may register a data handler
7077
and listen for objects to be passed to the handler:

0 commit comments

Comments
 (0)