Skip to content

Commit 7ffccf5

Browse files
committed
- Prettify README
1 parent 4a5afd5 commit 7ffccf5

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
decko [![NPM Version](http://img.shields.io/npm/v/decko.svg?style=flat)](https://npmjs.com/package/decko)
2-
=====
1+
# decko [![NPM Version](http://img.shields.io/npm/v/decko.svg?style=flat)](https://npmjs.com/package/decko)
32

43
> A collection of the most useful [decorators](https://github.com/wycats/javascript-decorators).
54
65

7-
Installation
8-
------------
6+
## Installation
97

108
Available on [npm](https://npmjs.com/package/decko):
119

@@ -14,8 +12,7 @@ npm i -S decko
1412
```
1513

1614

17-
Usage
18-
-----
15+
## Usage
1916

2017
Each decorator method is available as a named import.
2118

@@ -24,7 +21,7 @@ import { bind, memoize, debounce } from 'decko';
2421
```
2522

2623

27-
# `@bind`
24+
### `@bind`
2825

2926
```js
3027
class Example {
@@ -41,7 +38,7 @@ assert.equal(e.foo(), e);
4138

4239

4340

44-
# `@memoize`
41+
### `@memoize`
4542

4643
> Cache values returned from the decorated function.
4744
> Uses the first argument as a cache key.
@@ -77,7 +74,7 @@ let three = e.expensive(2);
7774

7875

7976

80-
# `@debounce`
77+
### `@debounce`
8178

8279
> Throttle calls to the decorated function. To debounce means "call this at most once per N ms".
8380
> All outward function calls get collated into a single inward call, and only the latest (most recent) arguments as passed on to the debounced function.
@@ -99,3 +96,11 @@ let e = new Example();
9996
// this will only call foo() once:
10097
for (let i=1000; i--) e.foo();
10198
```
99+
100+
101+
---
102+
103+
License
104+
-------
105+
106+
MIT

0 commit comments

Comments
 (0)