From 9523cb40eb0d16db2381010a972580bbb0b3407f Mon Sep 17 00:00:00 2001
From: SS <66886825+EarlMilktea@users.noreply.github.com>
Date: Sat, 28 Sep 2024 04:34:06 +0900
Subject: [PATCH 1/2] :technologist: Ignore _version.py

---
 .coveragerc | 2 ++
 1 file changed, 2 insertions(+)
 create mode 100644 .coveragerc

diff --git a/.coveragerc b/.coveragerc
new file mode 100644
index 0000000..54425bd
--- /dev/null
+++ b/.coveragerc
@@ -0,0 +1,2 @@
+[run]
+omit = src/pypkg_template/_version.py

From be773686c9c257b0dd4641172890f34716846788 Mon Sep 17 00:00:00 2001
From: SS <66886825+EarlMilktea@users.noreply.github.com>
Date: Sat, 28 Sep 2024 04:40:31 +0900
Subject: [PATCH 2/2] :memo: Update document

---
 README.md | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index b83ee04..3e2889d 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,27 @@
-# pypkg_template
+# 📦 pypkg_template
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![CI](https://github.com/todo-group/pypkg_template/actions/workflows/pytest.yaml/badge.svg)](https://github.com/todo-group/pypkg_template/actions/workflows/pytest.yaml)
 [![docs](https://github.com/todo-group/pypkg_template/actions/workflows/docs.yaml/badge.svg)](https://github.com/todo-group/pypkg_template/actions/workflows/docs.yaml)
 [![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)
 
-Python package template with the modern toml-based style.
+Python package template with the modern [toml-based style](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html).
 
-See [here](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html) for more details.
+## ☑ Features
 
-## How to use
+- Modern `pyproject.toml`-based configuration
+  - Dynamic versioning with `setuptools_scm`
+  - Typing support with `py.typed`
+- Testing with `pytest`
+  - Cross-platform CI integrations
+  - Coverage measurement with `pytest-cov`
+- Various linters
+  - `ruff` for linting, formatting, and import sorting
+  - `mypy`/`pyright` for static type checking
+- Documentation with `sphinx`
+  - Building with CI (WIP)
+
+## 🛠 How to use
 
 ### `pip` development