Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hotoo committed Oct 6, 2014
1 parent 4f0cba6 commit f01f0d5
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,7 @@ $ spm install markline --save

## Usage

for Web:

```js
var Markline = require('markline');
var $ = require("jquery");

$.get("./data/timeline.md", function(markdown){
var line = new Markline("#timeline", markdown);
line.render();
});
```

for Command Line Interface(CLI):
### for Command Line Interface(CLI):

```bash
$ markline server data.md
Expand All @@ -48,6 +36,18 @@ $ markline build data.md --dist _site

build pages in `dist` directory by default, you can set `--dist` argument for custom.

### for Web:

```js
var Markline = require('markline');
var $ = require("jquery");

$.get("./data/timeline.md", function(markdown){
var line = new Markline("#timeline", markdown);
line.render();
});
```

## API

### Markline(Object element, String markdown)
Expand Down

0 comments on commit f01f0d5

Please sign in to comment.