📝 Update README.md with project details, installation instructions, and usage examples

README.md

@@ -1,15 +1,144 @@
-# Pycord rest
+# Pycord REST
-The goal of this repository is to make pycord work with discord's http interactions, as described [here](https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction) and [here](https://discord.com/developers/docs/interactions/overview#preparing-for-interactions).
 
-To implement this, I will use:
+A lightweight wrapper for Discord's HTTP interactions using py-cord and FastAPI. This library enables you to build Discord bots that work exclusively through Discord's HTTP interactions, without requiring a WebSocket gateway connection.
-- fastapi - for the webserver
-- py-cord - for http only methods and reusing the command builders
 
-This would essentially be a wrapper of pycord providing its own classes and methods.
+## About
 
-todo:
+Pycord REST allows you to build Discord bots that respond to interactions via HTTP endpoints as described in [Discord's interaction documentation](https://discord.com/developers/docs/interactions/receiving-and-responding) and [interaction overview](https://discord.com/developers/docs/interactions/overview#preparing-for-interactions).
-- [ ] webserver
+
-- [ ] Slash commands
+This project is built on:
-- [ ] Slash options
+- **FastAPI** - For handling the HTTP server
-- [ ] Slash autocomplete
+- **py-cord** - Leveraging Discord command builders and interaction handling
-- [ ] UI components
+- **uvicorn** - ASGI server implementation
+
+## Installation
+
+```bash
+pip install pycord-reactive-bot
+```
+
+## Quick Start
+
+```python
+from pycord_rest import App
+import discord
+
+app = App(intents=discord.Intents.default())
+
+@app.slash_command(name="ping", description="Responds with pong!")
+async def ping(ctx):
+    await ctx.respond("Pong!")
+
+if __name__ == "__main__":
+    app.run(
+        token="YOUR_BOT_TOKEN",
+        public_key="YOUR_PUBLIC_KEY",  # From Discord Developer Portal
+        uvicorn_options={
+            "host": "0.0.0.0",
+            "port": 8000
+        }
+    )
+```
+
+## Usage
+
+### Setting up your bot on Discord
+
+1. Create a bot on the [Discord Developer Portal](https://discord.com/developers/applications)
+2. Enable the "Interactions Endpoint URL" for your application 
+3. Set the URL to your public endpoint where your bot will receive interactions
+4. Copy your public key from the Developer Portal to verify signatures
+
+### Features
+
+- Slash Commands
+- UI Components (buttons, select menus)
+- Modal interactions
+- Autocomplete for commands
+
+### Similarities to py-cord
+
+Syntax is equivalent to py-cord, as it is what is being used under the hood, making it easy to adapt existing bots:
+
+```python
+@app.slash_command(name="hello", description="Say hello")
+async def hello(ctx, user: discord.Member = None):
+    user = user or ctx.author
+    await ctx.respond(f"Hello {user.mention}!")
+
+@app.slash_command()
+async def button(ctx):
+    view = discord.ui.View()
+    view.add_item(discord.ui.Button(label="Click me!", custom_id="my_button"))
+    await ctx.respond("Press the button!", view=view)
+```
+
+## Limitations
+
+This library works differently than traditional bots because it does not use Discord's WebSocket gateway:
+
+- **No Cache**: Since there's no gateway connection, there's no cache of guilds, channels, users, etc.
+- **Limited API Methods**: Many standard Discord.py/py-cord methods that rely on cache won't work properly:
+  - `app.get_channel()`, `app.get_guild()`, `app.get_user()`
+  - Presence updates
+  - Voice support
+  - Member tracking
+- **Event-Based Functions**: Only interaction-based events work; message events, etc. don't work
+
+Remember that this is an HTTP-only bot that responds exclusively to interactions triggered by users.
+
+## Configuration Options
+
+```python
+app.run(
+    token="YOUR_BOT_TOKEN",
+    public_key="YOUR_PUBLIC_KEY",
+    uvicorn_options={
+        "host": "0.0.0.0",
+        "port": 8000,
+        "log_level": "info",
+        # Any valid uvicorn server options
+    },
+    health=True  # Enable /health endpoint
+)
+```
+
+## Advanced Usage
+
+### Adding Custom FastAPI Routes
+
+```python
+from fastapi import Request
+
+@app.router.get("/custom")
+async def custom_endpoint(request: Request):
+    return {"message": "This is a custom endpoint"}
+```
+
+## Contributing
+
+Contributions are welcome! This project is in early development, so there might be bugs or unexpected behaviors.
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linting: `ruff check` and `ruff format`
+5. Submit a pull request
+
+### Development Tools
+
+- **Ruff**: For linting and formatting
+- **HashiCorp Copywrite**: For managing license headers
+- **basedpyright**: For type checking
+
+## Disclaimer
+
+This is an early-stage project and may have unexpected behaviors or bugs. Please report any issues you encounter.
+
+## License
+
+MIT License - Copyright (c) 2025 Paillat-dev
+
+---
+
+Made with ❤️ by Paillat-dev