Skip to content

Commit 0a8bd37

Browse files
add note about gidgethub docs
1 parent 6e1cbe9 commit 0a8bd37

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,13 @@ class YourAppConfig(AppConfig):
163163
> [!NOTE]
164164
> Handlers must be async functions as django-github-app uses gidgethub for webhook event routing which only supports async operations. Sync support is planned to better integrate with Django projects that don't use async.
165165
166-
For more information about GitHub webhook events and payloads, see:
166+
For more information about GitHub webhook events and payloads, see these pages in the GitHub docs:
167167
168168
- [Webhook events and payloads](https://docs.github.com/en/webhooks/webhook-events-and-payloads)
169169
- [About webhooks](https://docs.github.com/en/webhooks/about-webhooks)
170170
171+
For more details about how `gidgethub.sansio.Event` and webhook routing work, see the [gidgethub documentation](https://gidgethub.readthedocs.io).
172+
171173
## Features
172174
173175
### GitHub API Client

0 commit comments

Comments
 (0)