diff --git a/README.md b/README.md
index b8ae1ae..f0a5813 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,18 @@
-# Pycord REST
+
+
Pycord REST
+
+
+
+
+
+
+[](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
and FastAPI.
+
+
## Table of Contents
- [Overview](#overview)
@@ -14,6 +24,7 @@ and FastAPI.
- [Features](#features)
- [Interaction Handling](#interaction-handling)
- [Webhook Events](#webhook-events)
+ - [Type Safety](#type-safety)
- [Usage Examples](#usage-examples)
- [Basic Commands](#basic-commands)
- [Event Handling](#event-handling)
@@ -124,6 +135,15 @@ Handle Discord webhook events such as:
user
- **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.
+
+
+> [!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
@@ -243,6 +263,7 @@ These tools provide temporary URLs for testing without deploying to production.
**Development Tools**:
+- **uv**: For dependency management
- **Ruff**: For linting and formatting
- **HashiCorp Copywrite**: For managing license headers
- **basedpyright**: For type checking