Skip to content

Commit

Permalink
chore: fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
uetchy committed Oct 27, 2021
1 parent 2c88091 commit 33ab5a4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ jobs:
with:
fetch-depth: 0
- name: Set up Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v2
with:
node-version: "16"
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.16
go-version: "1.16"
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v2
with:
Expand Down
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![Actions Status: release](https://github.com/uetchy/gst/workflows/goreleaser/badge.svg)](https://github.com/uetchy/gst/actions?query=goreleaser)
[![sake.sh badge](https://sake.sh/uetchy/badge.svg)](https://sake.sh/uetchy)

**gst** is a simple toolbox that offers additional commands (`list`, `new`, `rm`, `doctor`, `update`, `fetch`) over [ghq](https://github.com/x-motemen/ghq) enabled environment.
**gst** is a simple toolbox that offers additional commands (`list`, `new`, `rm`, `doctor`, `update`, `fetch`) for [ghq](https://github.com/x-motemen/ghq).

See [Quick Install](https://github.com/uetchy/gst#quick-install) for the installation guide.

Expand All @@ -29,25 +29,19 @@ unpushed commits
409849d returns Promise.reject
```

with **--short** option:
with `--short` or `-s` option:

```bash
$ gst --short
/Users/uetchy/Repos/src/github.com/uetchy/ferret
/Users/uetchy/Repos/src/github.com/uetchy/gst
```

You can also use it with `peco`:

```bash
cd $(gst --short | peco)
```

### new

Create a new git repository.

Before start using 'new' and 'rm' command, You **must** set 'github.user' to .gitconfig: `git config --global github.user <user>`.
Before start using `new` and `rm` command, You **must** set `github.user` in gitconfig to your GitHub username: `git config --global github.user <user>`.

```bash
$ gst new epic-project
Expand All @@ -56,13 +50,13 @@ $ gst new epic-team/epic-project
/Users/uetchy/Repos/src/github.com/epic-team/epic-project
```

with `cd`, You can jump to the created project:
With `cd`, you can jump to the created project quickly:

```bash
cd $(gst new epic-project)
```

It's good for having an alias for this workflow:
It's also good for having a handy alias for this workflow:

```bash
newrepo() {
Expand All @@ -72,10 +66,10 @@ newrepo() {

### rm

Remove a git repository. It also removes the containing directory if the deleted repository was the sole repository the parent directory has.
Remove a git repository. It also removes the containing directory if the deleted repository was the sole repository the parent directory had.

```bash
$ gst rm retired-project`
$ gst rm retired-project
Remove? /Users/uetchy/Repos/src/github.com/uetchy/retired-project [Y/n]
Removed /Users/uetchy/Repos/src/github.com/uetchy/retired-project
Removed /Users/uetchy/Repos/src/github.com/uetchy
Expand Down Expand Up @@ -138,7 +132,7 @@ chmod +x /usr/local/bin/gst

### Run as Docker container

You can take a glance at what `gst` do before installing the actual binary, by running the containerized Docker image.
You can take a glance at what `gst` do before installing the actual binary by running the containerized Docker image.

```bash
alias gst="docker run --rm -v \$(ghq root):/ghq -it uetchy/gst"
Expand Down

0 comments on commit 33ab5a4

Please sign in to comment.