diff --git a/README.md b/README.md index 49fa8dd..a9c864c 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@
-| Feature | Value | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Technology | [![Python](https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white)](https://www.python.org/) [![Ape](https://img.shields.io/badge/Built%20with-Ape-blue.svg)](https://github.com/ApeWorX/ape) [![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white)](https://github.com/features/actions) [![Pytest](https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white)](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml/badge.svg) [![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org) | -| Linting | [![Code style: black](https://img.shields.io/badge/Code%20Style-black-000000.svg)](https://github.com/psf/black) ![Style Guide](https://img.shields.io/badge/Style%20Guide-Flake8-blue) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) | -| Type Checking | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) | -| CI/CD | [![Tests](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml/badge.svg)](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml) [![Labeler](https://github.com/alienrobotninja/beePy/actions/workflows/labeler.yml/badge.svg)](https://github.com/alienrobotninja/beePy/actions/workflows/labeler.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) | -| Docs | [![Read the Docs](https://img.shields.io/readthedocs/beePy/latest.svg?label=Read%20the%20Docs)](https://beePy.readthedocs.io/) | -| Package | [![PyPI - Version](https://img.shields.io/pypi/v/beePy.svg)](https://pypi.org/project/beePy/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/beePy)](https://pypi.org/project/beePy/) [![PyPI - License](https://img.shields.io/pypi/l/beePy)](https://pypi.org/project/beePy/) | +| Feature | Value | +| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Technology | [![Python](https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white)](https://www.python.org/) [![Ape](https://img.shields.io/badge/Built%20with-Ape-blue.svg)](https://github.com/ApeWorX/ape) [![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white)](https://github.com/features/actions) [![Pytest](https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white)](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml/badge.svg) [![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org) | +| Linting | [![Code style: black](https://img.shields.io/badge/Code%20Style-black-000000.svg)](https://github.com/psf/black) ![Style Guide](https://img.shields.io/badge/Style%20Guide-Flake8-blue) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) | +| Type Checking | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) | +| CI/CD | [![Tests](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml/badge.svg)](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml) [![Labeler](https://github.com/alienrobotninja/beePy/actions/workflows/labeler.yml/badge.svg)](https://github.com/alienrobotninja/beePy/actions/workflows/labeler.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) | +| Docs | [![Read the Docs](https://img.shields.io/readthedocs/beePy/latest.svg?label=Read%20the%20Docs)](https://beePy.readthedocs.io/) | +| Package | [![PyPI - Version](https://img.shields.io/pypi/v/beePy.svg)](https://pypi.org/project/beePy/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/beePy)](https://pypi.org/project/beePy/) [![PyPI - License](https://img.shields.io/pypi/l/beePy)](https://pypi.org/project/beePy/) | | Meta | [![GitHub license](https://img.shields.io/github/license/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy/blob/main/LICENSE) [![GitHub last commit](https://img.shields.io/github/last-commit/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy/commits/main) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy/graphs/commit-activity) [![GitHub top language](https://img.shields.io/github/languages/top/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy) |
@@ -22,7 +22,7 @@ - [✨ Features](#-features) - [📋 Requirements](#-requirements) - [🚀 Testing Locally](#-testing-locally) - - [🛠️ Installation](#️-installation) + - [🛠️ Installation](#%EF%B8%8F-installation) - [🚀 Usage](#-usage) - [🐝 Bee Endpoint](#-bee-endpoint) - [🚀 Bee Debug Endpoint](#-bee-debug-endpoint) @@ -165,7 +165,6 @@ please \[file an issue\] along with a detailed description. ## 📚 Documentation - You can find the full documentation [here](https://bee-js.ethswarm.org/docs). The API reference documentation can be found [here](https://bee-js.ethswarm.org/docs/api). ## 👏 Credits