Skip to content

Commit

Permalink
Merge pull request #58 from jiko21/chore/update-docs
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
jiko21 committed Jan 18, 2024
2 parents 1784a67 + cda854b commit cd98005
Showing 1 changed file with 23 additions and 16 deletions.
39 changes: 23 additions & 16 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,28 @@ description: Branch delete tool made by Golang
---

# 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
Expand All @@ -35,25 +35,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
```

0 comments on commit cd98005

Please sign in to comment.