Skip to content

Commit

Permalink
Updae
Browse files Browse the repository at this point in the history
  • Loading branch information
syuilo committed Sep 14, 2016
1 parent bfac32b commit 2080bd4
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
summaly
=======

[![][npm-badge]][npm-link]

Get any web page's summary.

Installation
Expand All @@ -9,7 +11,15 @@ Installation

Usage
-----
`(url: string) => Promise<string>`
```
(url: string) => Promise<{
title: string;
icon: string;
description: string;
thumbnail: string;
sitename: string;
}>
```

### Example
``` javascript
Expand All @@ -21,3 +31,6 @@ const info = await summaly('http://example.com');
License
-------
[MIT](LICENSE)

[npm-link]: https://www.npmjs.com/package/summaly
[npm-badge]: https://img.shields.io/npm/v/summaly.svg?style=flat-square

0 comments on commit 2080bd4

Please sign in to comment.