From 524e0bc9cef2a8643dcd4d3627a9ae69b3e515cc Mon Sep 17 00:00:00 2001
From: takunomi-build-bot <build-bot@takunomi.space>
Date: Wed, 5 Mar 2025 09:54:18 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?=
 =?UTF-8?q?to=20latest=20version?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
---
 README.md | 14 ++++++++++++++
 setup.py  | 14 ++++++++++++++
 2 files changed, 28 insertions(+)

diff --git a/README.md b/README.md
index a74dd75..7b060ab 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,20 @@ Tool for standardizing Partisia's Java tests.
 Is capable of migrating from Javadoc based property specification to the
 `@DisplayName` specification and back.
 
+## Usage
+
+Convert tests with `@DisplayName` to Javadoc:
+
+```bash
+python -m standardize_java_text --javadoc --only-displayname FILE...
+```
+
+It it recommended that you do this with no unstaged changes, to more easily
+verify the result.
+
+You may need to call your formatting tool afterwards, as the converter doesn't
+take formatting into account.
+
 ## Dependencies
 
 This project does not have any dependencies 😎
diff --git a/setup.py b/setup.py
index 01af23a..36e6af8 100644
--- a/setup.py
+++ b/setup.py
@@ -17,6 +17,20 @@ Tool for standardizing Partisia's Java tests.
 
 Is capable of migrating from Javadoc based property specification to the
 `@DisplayName` specification and back.
+
+## Usage
+
+Convert tests with `@DisplayName` to Javadoc:
+
+```bash
+python -m standardize_java_text --javadoc --only-displayname FILE...
+```
+
+It it recommended that you do this with no unstaged changes, to more easily
+verify the result.
+
+You may need to call your formatting tool afterwards, as the converter doesn't
+take formatting into account.
 """.strip()
 
 PACKAGE_DESCRIPTION_SHORT = """