Skip to content

Commit d3ce455

Browse files
add introduction to README
1 parent dd4791f commit d3ce455

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<!-- docs-intro-begin -->
21
# django-github-app
32

43
[![PyPI](https://img.shields.io/pypi/v/django-github-app)](https://pypi.org/project/django-github-app/)
@@ -8,7 +7,9 @@
87
<!-- django-4.2 | 5.0 | 5.1-#44B78B -->
98
<!-- labelColor=%23092E20 -->
109

11-
<!-- docs-intro-end -->
10+
A Django app for building GitHub Apps, providing the foundational components needed to receive webhooks and interact with GitHub's API.
11+
12+
Built on [gidgethub](https://github.com/gidgethub/gidgethub) and [httpx](https://github.com/encode/httpx), django-github-app handles the boilerplate of GitHub App development. Features include webhook event routing and storage, an async-first API client with automatic authentication, and models for managing GitHub App installations, repositories, and webhook event history. The library is async-only at the moment (following gidgethub), with sync support planned to better integrate with Django projects.
1213

1314
## Requirements
1415

0 commit comments

Comments
 (0)