Update metadata

.github/workflows/publish.yaml

@@ -17,6 +17,7 @@ jobs:
     name: Publish (${{ inputs.os }}, python${{ inputs.python-version }})
     environment:
       name: release
+      url: https://pypi.org/project/mypypp
     steps:
       - name: Synchronize repository
         uses: actions/checkout@v4

CHANGELOG.md

@@ -7,9 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.1] - 2024-03-16
+
+### Fixed
+
+- Missing details in package metadata.
+
+## [0.1.0] - 2024-03-16
+
 ### Added
 
 - Mypy plugin to check for `warnings.deprecated` (or `typing_extensions.deprecated`) decorator on functions, methods and classes. Add `"mypypp.deprecated"` to `plugins` MyPy configuration to use it.
 
-[Unreleased]: https://github.com/bendabir/mypypp/compare/0.1.0...main
+[Unreleased]: https://github.com/bendabir/mypypp/compare/0.1.1...main
+[0.1.1]: https://github.com/bendabir/mypypp/compare/0.1.0...0.1.1
 [0.1.0]: https://github.com/bendabir/mypypp/tree/0.1.0

README.md

@@ -1,3 +1,58 @@
 # MyPy++
 
+![GitHub Tag](https://img.shields.io/github/v/tag/bendabir/mypypp?sort=semver&label=version)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypypp)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/mypypp)
+![PyPI - License](https://img.shields.io/pypi/l/mypypp)
+![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/pypi/mypypp)
+![GitHub deployments](https://img.shields.io/github/deployments/bendabir/mypypp/release?label=release)
+
 Collection of experimental plugins for MyPy.
+
+## Installation
+
+First, install the plugins with your favorie package manager (`pip`, `poetry`, etc.).
+
+```python
+pip install mypypp
+```
+
+## Usage
+
+In your MyPy configuration file, declare the plugins you want to use. For example, within a `pyproject.toml` configuration file :
+
+```toml
+[tool.mypy]
+plugins = ["mypypp.deprecated"]
+```
+
+## Development
+
+The whole project relies on Poetry for setup. It has been developed with Python 3.8 for backward compatibility.
+
+### Environment
+
+```bash
+poetry env use python3.8
+poetry lock
+poetry install --with dev
+poetry run pre-commit install
+```
+
+### Quality
+
+```bash
+poetry run black . # Format code
+poetry run ruff check --fix --force-exclude . # Lint code
+poetry run mypy --ignore-missing-imports --scripts-are-modules . # Type check code
+```
+
+```bash
+poetry run python -m pytest --cov=src/mypypp tests # Run all tests
+```
+
+### Build
+
+```bash
+poetry build -f wheel
+```

pyproject.toml

@@ -1,10 +1,15 @@
 # --- poetry ---
 [tool.poetry]
 name = "mypypp"
-version = "0.1.0"
+version = "0.1.1"
 description = "Collection of experimental plugins for MyPy."
+license = "GPL-3.0-or-later"
 authors = ["Bendabir"]
 readme = "README.md"
+homepage = "https://github.com/bendabir/mypypp"
+repository = "https://github.com/bendabir/mypypp"
+documentation = "https://github.com/Bendabir/mypypp/README.md"
+keywords = ["mypy", "mypy-plugin"]
 packages = [{ include = "mypypp", from = "src" }]
 
 [tool.poetry.dependencies]