From 78c65350d5ca65c24a2f3ed66f0ca90a4ae86367 Mon Sep 17 00:00:00 2001 From: Stephen Kraus <8003332+stephenmk@users.noreply.github.com> Date: Mon, 1 May 2023 19:17:26 -0500 Subject: [PATCH] Update README.md --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 66 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 30fb8af..222fb3a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ compiling the scraped data into compact dictionary file formats. * [新明解国語辞典 第八版](https://www.monokakido.jp/ja/dictionaries/smk8/index.html) * [大辞林 第四版](https://www.monokakido.jp/ja/dictionaries/daijirin2/index.html) - ### Supported Output Formats * [Yomichan](https://github.com/foosoft/yomichan) @@ -33,15 +32,78 @@ options: -i IMAGE_DIR, --image-dir IMAGE_DIR path to directory containing image folders (gaiji, graphics, etc.) - ``` ### Online Targets -Jitenbot will scrape the target website and save the pages to the [user's cache directory](https://pypi.org/project/platformdirs/). +Jitenbot will scrape the target website and save the pages to the [user cache directory](https://pypi.org/project/platformdirs/). As a courtesy to the website owners, jitenbot is configured to pause for 10 seconds between each page request. Consequently, a complete crawl of a target website may take several hours. +HTTP request headers (user agent string, etc.) may be customized by editing the `config.json` file created in the +[user config directory](https://pypi.org/project/platformdirs/). + ### Offline Targets -Page data and image data must be supplied by the user and passed to jitenbot via the appropriate command line flags. +Page data and image data must be procured by the user +and passed to jitenbot via the appropriate command line flags. # Attribution `Adobe-Japan1_sequences.txt` is provided by [The Adobe-Japan1-7 Character Collection](https://github.com/adobe-type-tools/Adobe-Japan1). + +# Examples + +### 四字熟語辞典オンライン +
+ 白玉微瑕 (web) + + ![yoji_hakugyokunobika_web](https://user-images.githubusercontent.com/8003332/235552346-50862906-df26-41a6-aa8f-c8b7e3df0e60.png) +
+ +
+ 白玉微瑕 (yomichan) + + ![yoji_hakugyokunobika](https://user-images.githubusercontent.com/8003332/235552362-c187c241-930e-4dff-b046-d72272272b6b.png) +
+ +--- + +### 故事・ことわざ・慣用句オンライン +
+ 怒髪、冠を衝く (web) + + ![kotowaza_dohatsu_web](https://user-images.githubusercontent.com/8003332/235552184-893bc0f7-83ef-4d4c-bc43-59cf81971419.png) +
+ +
+ 怒髪、冠を衝く (yomichan) + + ![kotowaza_dohatsu_yomi](https://user-images.githubusercontent.com/8003332/235552202-1301a875-ca39-4ce1-896f-64c26915a5ac.png) +
+ +--- + +### 新明解国語辞典 第八版 +
+ 離れる (print) + + ![smk8_hanareru_print](https://user-images.githubusercontent.com/8003332/235550560-e32f1ac8-2333-4ed9-adfc-a8e47ba187a0.png) +
+ +
+ 離れる (yomichan) + + ![smk8_hanareru_yomichan](https://user-images.githubusercontent.com/8003332/235550676-024a0d82-b695-45e8-96e8-b8a4f5bf4ffb.png) +
+ +--- + +### 大辞林 第四版 +
+ 令月 (print) + + ![daijirin_reigetsu_print](https://user-images.githubusercontent.com/8003332/235550833-5ca99ab8-1255-419f-ae86-228b57b3da02.png) +
+ +
+ 令月 (yomichan) + + ![daijirin_reigetsu_yomichan](https://user-images.githubusercontent.com/8003332/235550802-4d008264-205a-4fc2-9bf5-6af31cf7b910.png) +