From 901bb2c76645e3f75a74885a08651ab21dbb6228 Mon Sep 17 00:00:00 2001
From: aura <nw@moneybot.cc>
Date: Tue, 17 Feb 2026 01:06:44 +0100
Subject: update readme

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index 9c1a57f..f7cf663 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
 # zjisho
 a tool to create japanese definitions using jisho api
+
+usage:
+
+```
+zjisho [-d <definition_count> -s <senses_count>] <word>
+```
+
+example:
+
+```
+~ » zjisho 開く     
+開く（ひらく） - to open/to undo/to unseal, to bloom/to unfold/to spread out, to open (for business, e.g. in the morning), to be wide (gap, etc.)/to widen, etc...
+~ » zjisho -s 1 -d 1 死ぬ
+死ぬ（しぬ） - to die, etc...
+```
+
+there is also an included zjisho-clipboard script, which uses xclip to replace a japanese term in the clipboard with zjisho output.
-- 
cgit v1.2.3