mirror of
https://github.com/Paillat-dev/pycord-rest.git
synced 2026-01-02 00:56:19 +00:00
📝 Enhance README.md with badges
This commit is contained in:
23
README.md
23
README.md
@@ -1,8 +1,18 @@
|
|||||||
# Pycord REST
|
<div align="center">
|
||||||
|
<h1>Pycord REST</h1>
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
[](https://results.pre-commit.ci/latest/github/Paillat-dev/pycord-rest/main)
|
||||||
|
|
||||||
A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord
|
A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord
|
||||||
and FastAPI.
|
and FastAPI.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
@@ -14,6 +24,7 @@ and FastAPI.
|
|||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Interaction Handling](#interaction-handling)
|
- [Interaction Handling](#interaction-handling)
|
||||||
- [Webhook Events](#webhook-events)
|
- [Webhook Events](#webhook-events)
|
||||||
|
- [Type Safety](#type-safety)
|
||||||
- [Usage Examples](#usage-examples)
|
- [Usage Examples](#usage-examples)
|
||||||
- [Basic Commands](#basic-commands)
|
- [Basic Commands](#basic-commands)
|
||||||
- [Event Handling](#event-handling)
|
- [Event Handling](#event-handling)
|
||||||
@@ -124,6 +135,15 @@ Handle Discord webhook events such as:
|
|||||||
user
|
user
|
||||||
- **Entitlement creation** - When a user subscribes to your app's premium features
|
- **Entitlement creation** - When a user subscribes to your app's premium features
|
||||||
|
|
||||||
|
### Type Safety
|
||||||
|
|
||||||
|
Pycord REST is fully type-annotated and type-safe. It uses `basedpyright` for type
|
||||||
|
checking.
|
||||||
|
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
> [!NOTE]
|
||||||
|
> While Pycord REST itself is fully typed, the underlying py-cord library has limited type annotations, which may affect type checking in some areas.
|
||||||
|
|
||||||
## Usage Examples
|
## Usage Examples
|
||||||
|
|
||||||
<!-- prettier-ignore -->
|
<!-- prettier-ignore -->
|
||||||
@@ -243,6 +263,7 @@ These tools provide temporary URLs for testing without deploying to production.
|
|||||||
|
|
||||||
**Development Tools**:
|
**Development Tools**:
|
||||||
|
|
||||||
|
- **uv**: For dependency management
|
||||||
- **Ruff**: For linting and formatting
|
- **Ruff**: For linting and formatting
|
||||||
- **HashiCorp Copywrite**: For managing license headers
|
- **HashiCorp Copywrite**: For managing license headers
|
||||||
- **basedpyright**: For type checking
|
- **basedpyright**: For type checking
|
||||||
|
|||||||
Reference in New Issue
Block a user