diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 0000000..bd91d62 --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,29 @@ +name: Check links in README.md + +on: + schedule: + # Every 4 hours at X:00 + - cron: "0 */4 * * *" + workflow_dispatch: + +jobs: + check-links: + runs-on: ubuntu-latest + name: Check links in README.md + steps: + - uses: actions/checkout@v3 + + - name: Get links + run: | + grep -Eo "\[[^][]+]\((https?://stytch.com[^()]+)\)" README.md | grep -Eo "https:[^)]*" | sort -u > links.txt + found_bad=0 + for link in $(cat links.txt); do + status_code=$(curl -s -o /dev/null -w "%{http_code}" $link) + if [[ "$status_code" != "200" ]]; then + echo "$link -> $status_code" + found_bad=1 + fi + done + if [[ $found_bad == 1 ]]; then + exit 1 + fi diff --git a/README.md b/README.md index 3df5e89..88c4579 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,18 @@ Or install it yourself as: You can find your API credentials in the [Stytch Dashboard](https://stytch.com/dashboard/api-keys). -This client library supports all of Stytch's live products: +This client library supports all Stytch's live products: - [x] [Email Magic Links](https://stytch.com/docs/api/send-by-email) - - [x] [Embeddable Magic Links](https://stytch.com/docs/api/create-magic-link-overview) - - [x] [OAuth logins](https://stytch.com/docs/api/oauth-overview) + - [x] [Embeddable Magic Links](https://stytch.com/docs/guides/magic-links/embeddable-magic-links/api) + - [x] [OAuth logins](https://stytch.com/docs/guides/oauth/idp-overview) - [x] [SMS passcodes](https://stytch.com/docs/api/send-otp-by-sms) - [x] [WhatsApp passcodes](https://stytch.com/docs/api/whatsapp-send) - [x] [Email passcodes](https://stytch.com/docs/api/send-otp-by-email) - - [x] [Session Management](https://stytch.com/docs/api/sessions-overview) - - [x] [WebAuthn](https://stytch.com/docs/api/webauthn-overview) - - [x] [Time-based one-time passcodes (TOTPs)](https://stytch.com/docs/api/totps-overview) - - [x] [Crypto wallets](https://stytch.com/docs/api/crypto-wallet-overview) - - [x] [Passwords (Beta)](https://stytch.com/docs/api/password-overview) + - [x] [Session Management](https://stytch.com/docs/guides/sessions/using-sessions) + - [x] [WebAuthn](https://stytch.com/docs/guides/webauthn/api) + - [x] [Time-based one-time passcodes (TOTPs)](https://stytch.com/docs/guides/totp/api) + - [x] [Crypto wallets](https://stytch.com/docs/guides/web3/api) + - [x] [Passwords](https://stytch.com/docs/guides/passwords/api) ### Example usage Create an API client: @@ -79,7 +79,7 @@ If you've found a bug, [open an issue](https://github.com/stytchauth/stytch-ruby If you have questions or want help troubleshooting, join us in [Slack](https://join.slack.com/t/stytch/shared_invite/zt-nil4wo92-jApJ9Cl32cJbEd9esKkvyg) or email support@stytch.com. -If you've found a security vulnerability, please follow our [responsible disclosure instructions](https://stytch.com/docs/security). +If you've found a security vulnerability, please follow our [responsible disclosure instructions](https://stytch.com/docs/resources/security-and-trust/security#:~:text=Responsible%20disclosure%20program). ## Development