docs

kakkokari-gtyih · Feb 5, 2017 · 337945d · 337945d
1 parent 135530b
commit 337945d
Showing 1 changed file with 12 additions and 3 deletions.
diff --git 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<ISummary>;
+}
+```
 
 ### Returns
 A Promise of an Object that contains properties below: