Skip to content

Commit a31d5ad

Browse files
committed
Refactor readme.md
1 parent 7129f2c commit a31d5ad

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

readme.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# unist-util-inspect [![Build Status](https://img.shields.io/travis/wooorm/unist-util-inspect.svg)](https://travis-ci.org/wooorm/unist-util-inspect) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/unist-util-inspect.svg)](https://codecov.io/github/wooorm/unist-util-inspect?branch=master)
1+
# unist-util-inspect [![Build Status][build-badge]][build-page] [![Coverage Status][coverage-badge]][coverage-page]
22

3-
[Unist](https://github.com/wooorm/unist) node inspector.
3+
[Unist][] node inspector.
44

55
## Installation
66

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

99
```bash
1010
npm install unist-util-inspect
1111
```
1212

1313
**unist-util-inspect** is also available as an AMD, CommonJS, and
14-
globals module, [uncompressed and compressed](https://github.com/wooorm/unist-util-inspect/releases).
14+
globals module, [uncompressed and compressed][releases].
1515

1616
## Usage
1717

@@ -45,24 +45,46 @@ RootNode[1] (1:1-1:18, 0-17)
4545

4646
## API
4747

48-
### inspect([node](https://github.com/wooorm/unist#unist-nodes))
48+
### `inspect(node)`
4949

50-
By default, color support is enabled on node and turned off anywhere else.
50+
By default, color support is enabled on Node.js and turned off anywhere else.
5151
See below on how to change that.
5252

5353
**Parameters**
5454

55-
* `node` ([`Node`](https://github.com/wooorm/unist#unist-nodes)).
55+
* `node` ([`Node`][node]).
5656

5757
**Returns** `string` — String representing `node`.
5858

59-
### inspect.\\<style>\[.\\<style>...](node)
59+
### `inspect.<style>[.<style>...](node)`
6060

61-
Where `style` is either `color` or `noColor`.
61+
Where `<style>` is either `color` or `noColor`.
6262

6363
To explicitly add or remove ANSI sequences, use either `inspect.color(node)`
6464
or `inspect.noColor(node)`.
6565

6666
## License
6767

68-
[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
68+
[MIT][license] © [Titus Wormer][author]
69+
70+
<!-- Definition -->
71+
72+
[build-badge]: https://img.shields.io/travis/wooorm/unist-util-inspect.svg
73+
74+
[build-page]: https://travis-ci.org/wooorm/unist-util-inspect
75+
76+
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/unist-util-inspect.svg
77+
78+
[coverage-page]: https://codecov.io/github/wooorm/unist-util-inspect?branch=master
79+
80+
[unist]: https://github.com/wooorm/unist
81+
82+
[npm]: https://docs.npmjs.com/cli/install
83+
84+
[releases]: https://github.com/wooorm/unist-util-inspect/releases
85+
86+
[node]: https://github.com/wooorm/unist#unist-nodes
87+
88+
[license]: LICENSE
89+
90+
[author]: http://wooorm.com

0 commit comments

Comments
 (0)