From e47b5d6079fba730a2997027d1e0cbf090eb97dc Mon Sep 17 00:00:00 2001 From: Tomoya Chiba Date: Thu, 16 May 2024 13:36:43 +0900 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 162e220..cf71c1b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ # yard → rbs-inline -Rewrite YARD type annotations in Your codes to rbs-inline. +Rewrite [YARD type annotations](https://yardoc.org/types.html) in Your codes to [rbs-inline](https://github.com/soutaro/rbs-inline). ## Usage +Install this gem with the following command. + ```console -bundle +gem install yard_to_rbs_inline +``` +Then, run the following command to insert rbs-inline comments to your code. + +```console # Print rewrited code to stdout. -./exe/yard-rbs-inline --dry-run your-file.rb +yard-rbs-inline --dry-run your-file.rb # Overwrite files. -./exe/yard-rbs-inline your-file.rb +yard-rbs-inline your-file.rb ```