Skip to content

Commit

Permalink
Tweak README
Browse files Browse the repository at this point in the history
  • Loading branch information
mixonic committed Jul 27, 2015
1 parent f13bbf8 commit d8064ae
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Mobiledoc DOM Renderer [![Build Status](https://travis-ci.org/bustlelabs/mobiledoc-dom-renderer.svg?branch=master)](https://travis-ci.org/bustlelabs/mobiledoc-dom-renderer)
## Mobiledoc DOM Renderer [![Build Status](https://travis-ci.org/bustlelabs/mobiledoc-dom-renderer.svg?branch=master)](https://travis-ci.org/bustlelabs/mobiledoc-dom-renderer)

This is a runtime renderer for the `mobiledoc` format.
It renders mobiledoc to DOM elements.

It is intended to be a small libraray that is run client-side in a browser that wants to display mobiledoc.

## Usage
### Usage

```
var mobiledoc = [
Expand All @@ -30,6 +30,13 @@ document.getElementById('output').appendChild(rendered);
// into 'output' element
```

## Tests
### Tests

* `npm test`

### Releasing

* `npm version patch` or `minor` or `major`
* `npm run build`
* `git push bustle --tags`
* `npm publish`

0 comments on commit d8064ae

Please sign in to comment.