From 6124190c66958a2b8611400e0a16456dc8d05c1a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Ricks?= <bjoern.ricks@greenbone.net>
Date: Tue, 11 Jul 2023 12:08:24 +0200
Subject: [PATCH] Add: Add README for mypy-python action

---
 mypy-python/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 mypy-python/README.md

diff --git a/mypy-python/README.md b/mypy-python/README.md
new file mode 100644
index 00000000..141cb6e8
--- /dev/null
+++ b/mypy-python/README.md
@@ -0,0 +1,35 @@
+# Mypy Python Action
+
+GitHub Action to check typings in Python project with [mypy].
+
+## Example
+
+```yml
+name: Type checking
+
+on:
+  pull_request:
+
+jobs:
+  lint-python:
+    name: Setup and lint project
+    runs-on: ubuntu-latest
+    steps:
+        - uses: greenbone/actions/mypy-python@v2
+          with:
+            packages: my_project tests
+```
+
+## Action Configuration
+
+|Input Variable|Description| |
+|--------------|-----------|-|
+| packages | Python packages to check | Required |
+| mypy-arguments | Additional arguments to mypy | Optional |
+| python-version | Python version to use for running the action. | Optional (default is `3.10`) |
+| poetry-version | Use a specific poetry version. By default the latest release is used. | Optional (default latest poetry version) |
+| cache | Cache dependencies by setting it to `"true"`. Leave unset or set to an other string then `"true"` to disable the cache. | Optional |
+| cache-dependency-path | Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies. | Optional |
+| cache-poetry-installation | "Cache poetry and its dependencies. Default is `"true"`. Set to an other string then `"true"` to disable the cache." | Optional (default: `"true"`) |
+
+[mypy]: https://mypy.readthedocs.io/en/stable/