Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing Markdown rendering on NPM site #56

Merged
merged 1 commit into from
Jul 17, 2017
Merged

Fixing Markdown rendering on NPM site #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ API
---

<a name="api"></a>

## API

* <a href="#msgpack"><code><b>msgpack()</b></code></a>
Expand All @@ -97,6 +98,7 @@ API

-------------------------------------------------------
<a name="msgpack"></a>

### msgpack(options(obj))

Creates a new instance on which you can register new types for being
Expand All @@ -109,12 +111,14 @@ options:

-------------------------------------------------------
<a name="encode"></a>

### encode(object)

Encodes `object` in msgpack, returns a [bl](http://npm.im/bl).

-------------------------------------------------------
<a name="decode"></a>

### decode(buf)

Decodes buf from in msgpack. `buf` can be a `Buffer` or a [bl](http://npm.im/bl) instance.
Expand All @@ -123,6 +127,7 @@ In order to support a stream interface, a user must pass in a [bl](http://npm.im

-------------------------------------------------------
<a name="registerEncoder"></a>

### registerEncoder(check(obj), encode(obj))

Register a new custom object type for being automatically encoded.
Expand All @@ -136,6 +141,7 @@ The arguments are:

-------------------------------------------------------
<a name="registerDecoder"></a>

### registerDecoder(type, decode(buf))

Register a new custom object type for being automatically decoded.
Expand All @@ -148,6 +154,7 @@ The arguments are:

-------------------------------------------------------
<a name="register"></a>

### register(type, constructor, encode(obj), decode(buf))

Register a new custom object type for being automatically encoded and
Expand All @@ -168,12 +175,14 @@ This is just a commodity that calls

-------------------------------------------------------
<a name="encoder"></a>

### encoder()

Builds a stream in object mode that encodes msgpack.

-------------------------------------------------------
<a name="decoder"></a>

### decoder()

Builds a stream in object mode that decodes msgpack.
Expand Down