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

README

Browse Source
This commit is contained in:
syuilo 2017-05-06 16:54:29 +09:00
parent 44de9c6793
commit 4cc6be225e
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,5 +1,5 @@
summaly
=======
================================================================
[![][npm-badge]][npm-link]
[![][mit-badge]][mit]
@ -12,20 +12,20 @@ summaly
Get any web page's summary. [Try it out](https://runkit.com/npm/summaly)
Installation
------------
----------------------------------------------------------------
`$ npm install summaly`
Usage
-----
----------------------------------------------------------------
``` javascript
summaly(url[, opts])
```
### Options
| Property | Type | Description | Default |
| :------------------ | :--------------------- | :-------------------------- | :------ |
| **followRedirects** | *boolean* | リダイレクトを解決するかどうか | `true` |
| **plugins** | *plugin[]* (see below) | Custom plugins | `null` |
| Property | Type | Description | Default |
| :------------------ | :--------------------- | :----------------------- | :------ |
| **followRedirects** | *boolean* | Whether follow redirects | `true` |
| **plugins** | *plugin[]* (see below) | Custom plugins | `null` |
#### Plugin
``` typescript
@ -40,12 +40,12 @@ A Promise of an Object that contains properties below:
| Property | Type | Description |
| :-------------- | :------- | :--------------------------------------- |
| **description** | *string* | The description of そのWebページ |
| **icon** | *string* | The url of the icon of そのWebページ |
| **sitename** | *string* | The name of そのWebサイト |
| **thumbnail** | *string* | The url of the thumbnail of そのWebページ |
| **title** | *string* | The title of そのWebページ |
| **url** | *string* | The url of そのWebページ |
| **description** | *string* | The description of the web page |
| **icon** | *string* | The url of the icon of the web page |
| **sitename** | *string* | The name of the web site |
| **thumbnail** | *string* | The url of the thumbnail of the web page |
| **title** | *string* | The title of the web page |
| **url** | *string* | The url of the web page |
### Example
``` javascript
@ -67,11 +67,11 @@ console.log(summary); // will be ... ↓
```
Testing
-------
----------------------------------------------------------------
`npm run test`
License
-------
----------------------------------------------------------------
[MIT](LICENSE)
[npm-link]: https://www.npmjs.com/package/summaly