From d8495dc8787276bf5c7aa26bf21ea05500c73779 Mon Sep 17 00:00:00 2001
From: phil <phil.dev@philome.mooo.com>
Date: Wed, 28 May 2025 16:37:10 +0000
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 4cb60ad..afc61cd 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,26 @@ It has 4 standard entry points, defined in `pyproject.toml`:
 
 It has a Forgejo CI build action, defined in `.forgejo/actions/build.yaml`.
 
+## Usage
+
+```fish
+set NAME knoc_foo
+set DNAME (echo $NAME | tr "_" "-")
+```
+
+or with bash:
+```bash
+NAME=knoc_foo
+DNAME=$(echo $NAME | tr "_" "-")
+```
+
+Then:
+```fish
+git clone https://code.philo.ydns.eu/K-Net/knoc-plugin-template.git $NAME
+cd $NAME
+rm -rf .git
+mv src/knoc_plugin_template src/$NAME
+sed  "s/knoc_plugin_template/$NAME/" -i pyproject.toml
+sed  "s/knoc-plugin-template/$DNAME/" -i pyproject.toml
+
+```