Update README.md

kakkokari-gtyih · Sep 12, 2016 · 7d40c19 · 7d40c19
1 parent 80b010a
commit 7d40c19
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,24 @@ Installation
 ------------
 `$ npm install webcard`
 
+Usage
+-----
+`(url: string, opts: Options) => Promise<string>`
+
+### Options
+| Property  | Type     | Description                               | Default |
+| :-------- | :------- | :---------------------------------------- | :------ |
+| **proxy** | *string* | URL of proxy that wrap non-https contents | `null`  |
+
+### Example
+``` javascript
+import webcard from 'webcard';
+
+const html = await webcard('http://example.com', {
+  proxy: 'https://your.proxy.com'
+});
+```
+
 License
 -------
 [MIT](LICENSE)