Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ospfranco committed Oct 31, 2024
1 parent 588072e commit 55353ce
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
Binary file removed .DS_Store
Binary file not shown.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules/
.vscode/
build/
build/
.DS_Store
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ If you use this library and find it useful please consider [sponsoring me](https

Allows you to extract information from an HTTP URL/link (or parse an HTML string) and retrieve meta information such as title, description, images, videos, etc. via **OpenGraph** tags.

## Discord

Join the Discord

https://discord.gg/W9XmqCQCKP

## GOTCHAs

- You cannot request a different domain from your web app (Browsers block cross-origin-requests). If you don't know how _same-origin-policy_ works, [here is a good intro](https://dev.to/lydiahallie/cs-visualized-cors-5b8h), therefore **this library works on Node.js and certain mobile run-times (Cordova or React-Native)**.
Expand Down Expand Up @@ -98,8 +104,8 @@ getLinkPreview("https://www.youtube.com/watch?v=MejbOFk7H6c", {
"Accept-Language": "fr-CA", // fetches site for French language
// ...other optional HTTP request headers
},
timeout: 1000
}).then(data => console.debug(data));
timeout: 1000,
}).then((data) => console.debug(data));
```

## SSRF Concerns
Expand Down

0 comments on commit 55353ce

Please sign in to comment.