Update README.md

This commit is contained in:
syuilo 2016-09-13 05:59:07 +09:00 committed by GitHub
parent 80b010a7f8
commit 7d40c19cc6

View File

@ -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)