Skip to content

Commit 201898d

Browse files
mxlcaitp
authored andcommitted
Fix README.md formatting. (#18)
- fix headings - replace "#" with "." as more conventional syntax - fix `send()` anchor reference
1 parent 1839bf7 commit 201898d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#node-mock-stdin
1+
# node-mock-stdin
22

33
[![Build Status](https://travis-ci.org/caitp/node-mock-stdin.svg?branch=master)](https://travis-ci.org/caitp/node-mock-stdin) [![Coverage Status](https://img.shields.io/coveralls/caitp/node-mock-stdin.svg)](https://coveralls.io/r/caitp/node-mock-stdin?branch=master) [![NPM Version](http://img.shields.io/npm/v/mock-stdin.svg)](https://www.npmjs.org/package/mock-stdin)
44

@@ -7,19 +7,19 @@ Provide a mock readable stream, useful for testing interactive CLI applications.
77
Maybe simple mocks for other standard files wouldn't be a terrible idea, if anyone
88
feels like those are needed. Patches welcome.
99

10-
##API
10+
## API
1111

1212
- **Module**
1313
- [stdin()](#modulestdin)
1414
- **MockSTDIN**
15-
- [send()](#mockstdinsenddata)
15+
- [send()](#mockstdinsenddata-encoding)
1616
- [end()](#mockstdinend)
1717
- [restore()](#mockstdinrestore)
1818
- [reset()](#mockstdinresetremovelisteners)
1919

2020
---
2121

22-
######Module#stdin()
22+
### Module.stdin()
2323

2424
**example**
2525

@@ -39,7 +39,7 @@ registered.
3939

4040
---
4141

42-
######MockSTDIN#send(data, encoding)
42+
### MockSTDIN.send(data, encoding)
4343

4444
**example**
4545

@@ -70,7 +70,7 @@ dispatched.
7070

7171
---
7272

73-
######MockSTDIN#end()
73+
### MockSTDIN.end()
7474

7575
**example**
7676

@@ -79,13 +79,13 @@ var stdin = require('mock-stdin').stdin();
7979
stdin.end();
8080
```
8181

82-
Alias for [MockSTDIN#send(null)](#mockstdinsend). Results in dispatching an `end` event.
82+
Alias for [MockSTDIN.send(null)](#mockstdinsend). Results in dispatching an `end` event.
8383

8484
**return value**: The `MockSTDIN` instance, for chaining.
8585

8686
---
8787

88-
######MockSTDIN#restore()
88+
### MockSTDIN.restore()
8989

9090
**example**
9191

@@ -104,7 +104,7 @@ stream which was active at the time the mock was created.
104104

105105
---
106106

107-
######MockSTDIN#reset(removeListeners)
107+
### MockSTDIN.reset(removeListeners)
108108

109109
**example**
110110

@@ -132,7 +132,7 @@ re-creating the mock object.
132132

133133
---
134134

135-
##[LICENSE](LICENSE)
135+
## [LICENSE](LICENSE)
136136

137137
The MIT License (MIT)
138138

0 commit comments

Comments
 (0)