From 2080bd4e8d15f5e0bcddf204cd72f3cc75c7a7ae Mon Sep 17 00:00:00 2001 From: syuilo Date: Thu, 15 Sep 2016 02:57:10 +0900 Subject: [PATCH] Updae --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 805dba5..9aa2cbf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ summaly ======= +[![][npm-badge]][npm-link] + Get any web page's summary. Installation @@ -9,7 +11,15 @@ Installation Usage ----- -`(url: string) => Promise` +``` +(url: string) => Promise<{ + title: string; + icon: string; + description: string; + thumbnail: string; + sitename: string; +}> +``` ### Example ``` javascript @@ -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