diff --git a/README.md b/README.md index 41c65d0..6c550c6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@

Pycord REST

+ + [![PyPI - Version](https://img.shields.io/pypi/v/pycord-rest-bot)](https://pypi.org/project/pycord-rest-bot/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pycord-rest-bot)](https://pypi.org/project/pycord-rest-bot/) [![PyPI - Types](https://img.shields.io/pypi/types/pycord-rest-bot)](https://pypi.org/project/pycord-rest-bot/) @@ -8,11 +10,19 @@ [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Paillat-dev/pycord-rest/CI.yaml)](https://github.com/Paillat-dev/pycord-rest/actions/workflows/CI.yaml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Paillat-dev/pycord-rest/main.svg)](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) @@ -60,6 +70,8 @@ pip install pycord-rest-bot --prerelease=allow > [!NOTE] > The package is currently in pre-release. + + ## Quick Start ```python diff --git a/pyproject.toml b/pyproject.toml index 6b359e4..e1433c0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,11 @@ [build-system] -requires = ["hatchling", "hatch-vcs"] +requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"] build-backend = "hatchling.build" [project] name = "pycord-rest-bot" -dynamic = ["version", "urls"] -description = "A discord rest-bot wrapper for pycord" -readme = "README.md" +dynamic = ["version", "urls", "readme"] +description = "A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord and FastAPI" authors = [ { name = "Paillat-dev", email = "me@paillat.dev" } ] @@ -47,6 +46,34 @@ version-file = "src/pycord_rest/_version.py" Homepage = "https://github.com/Paillat-dev/pycord-rest" source_archive = "https://github.com/Paillat-dev/pycord-rest/archive/{commit_hash}.zip" +[tool.hatch.metadata.hooks.fancy-pypi-readme] +content-type = "text/markdown" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "README.md" +start-after = "\n" +end-before = "\n" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +text = "\n\n---\n" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "README.md" +start-after = "## Overview\n" +end-before = "\n## Installation" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]] +path = "README.md" +start-after = "" + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]] +pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)' +replacement = '[\1](https://github.com/Paillat-dev/pycord-rest/tree/main\g<2>)' + +[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]] +pattern = '\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]' +replacement = '**\1**:' + [tool.hatchling] name = "pycord-rest-bot"