Skip to content

Commit 4d1c9bf

Browse files
committed
Refactor docs
1 parent 19ae33d commit 4d1c9bf

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

readme.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,55 @@
1-
# trim-trailing-lines [![Build Status](https://img.shields.io/travis/wooorm/trim-trailing-lines.svg?style=flat)](https://travis-ci.org/wooorm/trim-trailing-lines) [![Coverage Status](https://img.shields.io/coveralls/wooorm/trim-trailing-lines.svg?style=flat)](https://coveralls.io/r/wooorm/trim-trailing-lines?branch=master)
1+
# trim-trailing-lines [![Build Status][travtrim-trailing-lines]][travis] [![Coverage Status][codecov-badge]][codecov]
22

33
Remove final newline characters from a string.
44

55
## Installation
66

7-
[npm](https://docs.npmjs.com/cli/install):
7+
[npm][]:
88

99
```bash
1010
npm install trim-trailing-lines
1111
```
1212

13-
**trim-trailing-lines** is also available for [bower](http://bower.io/#install-packages),
14-
[component](https://github.com/componentjs/component), [duo](http://duojs.org/#getting-started),
15-
and for AMD, CommonJS, and globals ([uncompressed](trim-trailing-lines.js) and
16-
[compressed](trim-trailing-lines.min.js)).
17-
1813
## Usage
1914

20-
Dependencies.
21-
22-
```javascript
15+
```js
2316
var trimTrailingLines = require('trim-trailing-lines');
24-
```
25-
26-
Trim trailing newline characters:
2717

28-
```javascript
29-
trimTrailingLines('foo\nbar'); // 'foo\nbar'
30-
trimTrailingLines('foo\nbar\n'); // 'foo\nbar'
31-
trimTrailingLines('foo\nbar\n\n'); // 'foo\nbar'
18+
trimTrailingLines('foo\nbar'); //=> 'foo\nbar'
19+
trimTrailingLines('foo\nbar\n'); //=> 'foo\nbar'
20+
trimTrailingLines('foo\nbar\n\n'); //=> 'foo\nbar'
3221
```
3322

3423
## API
3524

36-
### trimTrailingLines(value)
25+
### `trimTrailingLines(value)`
3726

3827
Remove final newline characters from `value`.
3928

40-
Parameters:
29+
###### Parameters
4130

4231
* `value` (`string`) — Value with trailing newlines, coerced to string.
4332

44-
Returns: `string` — Value without trailing newlines.
33+
###### Returns
34+
35+
string\` — Value without trailing newlines.
4536

4637
## License
4738

48-
[MIT](LICENSE) @ [Titus Wormer](http://wooorm.com)
39+
[MIT][license] © [Titus Wormer][author]
40+
41+
<!-- Definitions -->
42+
43+
[travtrim-trailing-lines]: https://img.shields.io/travis/wooorm/trim-trailing-lines.svg
44+
45+
[travis]: https://travis-ci.org/wooorm/trim-trailing-lines
46+
47+
[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/trim-trailing-lines.svg
48+
49+
[codecov]: https://codecov.io/github/wooorm/trim-trailing-lines
50+
51+
[npm]: https://docs.npmjs.com/cli/install
52+
53+
[license]: LICENSE
54+
55+
[author]: http://wooorm.com

0 commit comments

Comments
 (0)