mirror of
https://github.com/misskey-dev/summaly.git
synced 2025-05-11 16:47:22 +09:00
Update README.md
This commit is contained in:
parent
80b010a7f8
commit
7d40c19cc6
18
README.md
18
README.md
@ -7,6 +7,24 @@ Installation
|
|||||||
------------
|
------------
|
||||||
`$ npm install webcard`
|
`$ 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
|
License
|
||||||
-------
|
-------
|
||||||
[MIT](LICENSE)
|
[MIT](LICENSE)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user