diff --git a/README.md b/README.md index 24a0855..abd3003 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,11 @@ A super lightweight library to validate if a given url is valid or not. Some add - Jest test cases with 100% coverage - Promise based result -## Usage (TypeScript) +## Usage + +**[Full documentation](https://opensource.stackblogger.com/link-exists/)** — API, config options, behavior notes, and more examples. + +### TypeScript ```typescript import { linkExists } from 'link-exists'; @@ -57,7 +61,7 @@ await linkExists('https://example.com', { details: true, timeout: 8000, method: // response: { exists: true, status: 200, url: 'https://example.com/' } ``` -## Usage (JavaScript) +### JavaScript ```javascript const { linkExists } = require('link-exists'); diff --git a/docs/index.html b/docs/index.html index 9c7feb8..620e6d3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,6 +5,15 @@ link-exists — docs + + +