misskey-dev/summaly
1
0
Fork 0
mirror of https://github.com/misskey-dev/summaly.git synced 2025-05-12 09:07:30 +09:00
Code Issues Packages Projects Releases Wiki Activity

Updae

Browse Source
This commit is contained in:
syuilo 2016-09-15 02:57:10 +09:00
parent bfac32b802
commit 2080bd4e8d
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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<string>`
```
(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