From 337945d5bbb4c60b80615631c6a026aebf7044b2 Mon Sep 17 00:00:00 2001 From: syuilo Date: Sun, 5 Feb 2017 21:22:36 +0900 Subject: [PATCH] docs --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a83b678..75e19f3 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,18 @@ summaly(url[, opts]) ``` ### Options -| Property | Type | Description | Default | -| :------------------ | :-------- | :-------------------------- | :------ | -| **followRedirects** | *boolean* | リダイレクトを解決するかどうか | `true` | +| Property | Type | Description | Default | +| :------------------ | :--------------------- | :-------------------------- | :------ | +| **followRedirects** | *boolean* | リダイレクトを解決するかどうか | `true` | +| **plugins** | *plugin[] (see below)* | Custom plugins | `null` | + +#### Plugin +``` typescript +interface IPlugin { + test: (url: URL.Url) => boolean; + summary: (url: URL.Url) => Promise; +} +``` ### Returns A Promise of an Object that contains properties below: