From 6aaa4cfbc867527994333aed801d23ca678a731a Mon Sep 17 00:00:00 2001 From: Apricot-S Date: Tue, 31 Mar 2026 20:26:59 +0900 Subject: [PATCH] docs: Improve README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b2ca3b..d815bb9 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ [![Linters and tests](https://github.com/MahjongRepository/mahjong/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/MahjongRepository/mahjong/actions/workflows/lint_and_test.yml) [![API Docs](https://img.shields.io/badge/api-master-yellow.svg)](https://mahjongrepository.github.io/mahjong) -This library can calculate hand cost (han, fu with details, yaku, and scores) for riichi mahjong (Japanese version). +Japanese riichi mahjong hand calculator library. -Also calculating of shanten is supported. +Compute hand cost (han, fu, yaku, and scores), validate winning hands, and calculate shanten (minimum tiles to tenpai). The code was validated on tenhou.net phoenix replays in total on **26,148,038 hands**.