Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jiko21 committed Jul 23, 2020
1 parent 3cca69a commit bec15f4
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 2 deletions.
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# Gomi
Branch delete tool made by golang
# GOMI
Branch delete tool made by Golang
## About
GOMI is a tool for deleting merged branches in 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

```bash
gomi
```

at your project.
## How to install
You can install via homebrew

```bash
brew tap jiko21/gomi
```

then,

```bash
brew install gomi
```

## Features

### branch delete block
You can specify the branches that you don't want to delete.

You can specify them with `.gomiignore`, on your project root.

If you don't use `.gomiignore`, then default rule will be adopted; `master`, `develop`, `release` cannot be deleted by gomi.

The example of `.gomiignore` is shown below.

```
master
do-not-delete-branch
master-xxx
```
17 changes: 17 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,20 @@ then,
```bash
brew install gomi
```

## Features

### branch delete block
You can specify the branches that you don't want to delete.

You can specify them with `.gomiignore`, on your project root.

If you don't use `.gomiignore`, then default rule will be adopted; `master`, `develop`, `release` cannot be deleted by gomi.

The example of `.gomiignore` is shown below.

```
master
do-not-delete-branch
master-xxx
```

0 comments on commit bec15f4

Please sign in to comment.