From 3102447e32c6a6496bc296b94f79f39c43f39e99 Mon Sep 17 00:00:00 2001 From: jiko21 Date: Tue, 16 Jan 2024 02:02:34 +0900 Subject: [PATCH] update: docs --- README.md | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a090fdb..a64ae43 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ # GOMI -Branch delete tool made by Golang +Branch delete tool made with Golang ## About -GOMI is a tool for deleting merged branches in local git repository. +GOMI is a tool for deleting branches that have been merged into the local git repository. -When you write code with git or github flow, -there are many branches that are already merged into master / develop branch. -You can delete branches merged into your current branch only with +When working with git or GitHub flow, +you often encounter many branches that have already been merged into the master or develop branches. + +You can delete branches that have been merged into your current branch simply by using the following command in your project: ```bash gomi ``` -at your project. ## How to install -You can install via homebrew +GOMI can be installed via Homebrew: ```bash brew tap jiko21/gomi ``` -then, +then,Then, install it with: ```bash brew install gomi @@ -29,25 +29,32 @@ brew install gomi ## Features ### branch delete block -You can specify the branches that you don't want to delete. +You can specify branches that you do not want to delete. -You can specify them with `.gomiignore`, on your project root. +This can be done using a .gomiignore file in your project's root directory. -If you don't use `.gomiignore`, then default rule will be adopted; `master`, `main`, `develop`, `release` cannot be deleted by gomi. +If you don't use a .gomiignore file, +the default rule applies: master, main, develop, and release branches cannot be deleted by GOMI. -The example of `.gomiignore` is shown below. +An example of a .gomiignore file is shown below: ``` master do-not-delete-branch master-xxx -# this is comment out -# this is ignored as gomiignore file +# this is commented out +# lines like this are ignored in the .gomiignore file ``` -### initialize -you can generate `.gomiignore` file with command shown below. +### Auto-Execution After Merging a Branch +You can configure GOMI to run automatically after merging a branch. + +This feature can be enabled during the initialization of GOMI. + +### Initialization +You can generate a .gomiignore file with the command shown below. +Afterward, Git hooks will be created for actions following a merge commit. ``` $ gomi init ```