Skip to content

Commit

Permalink
create readme
Browse files Browse the repository at this point in the history
  • Loading branch information
koki-develop committed Apr 15, 2023
1 parent 80082b9 commit 2ed386d
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# gh-grass

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/koki-develop/gh-grass)](https://github.com/koki-develop/gh-grass/releases/latest)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/koki-develop/gh-grass/ci.yml?logo=github)](https://github.com/koki-develop/gh-grass/actions/workflows/ci.yml)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/koki-develop/gh-grass?style=flat&logo=codeclimate)](https://codeclimate.com/github/koki-develop/gh-grass/maintainability)
[![Go Report Card](https://goreportcard.com/badge/github.com/koki-develop/gh-grass)](https://goreportcard.com/report/github.com/koki-develop/gh-grass)
[![LICENSE](https://img.shields.io/github/license/koki-develop/gh-grass)](./LICENSE)

sleep command with rich progress bar.

![demo](./docs/demo.gif)

- [Installation](#installation)
- [Usage](#usage)
- [LICENSE](#license)

## Installation

```console
$ gh extension install koki-develop/gh-grass
```

## Usage

```console
$ gh grass
```

![demo](./docs/demo.gif)

### Specify a User

You can specify a user with the `-u` or `--user` flag.

```console
$ gh grass --user <USERNAME>
```

![](./docs/user.gif)

## LICENSE

[MIT](./LICENSE)
Binary file added docs/demo.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions tapes/demo.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Output docs/demo.gif

Require gh

Set Shell "bash"
Set FontSize 32
Set Width 2200
Set Height 600
Set PlaybackSpeed 0.6

Hide
Type "go build ." Enter
Type "gh extension remove grass" Enter
Type "gh extension install ." Enter
Type "gh grass --help" Enter
Ctrl+l
Sleep 3s
Show

Type "gh grass" Sleep 500ms Enter

Sleep 5s
22 changes: 22 additions & 0 deletions tapes/user.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Output docs/user.gif

Require gh

Set Shell "bash"
Set FontSize 32
Set Width 2200
Set Height 600
Set PlaybackSpeed 0.6

Hide
Type "go build ." Enter
Type "gh extension remove grass" Enter
Type "gh extension install ." Enter
Type "gh grass --help" Enter
Ctrl+l
Sleep 3s
Show

Type "gh grass --user koki-develop" Sleep 500ms Enter

Sleep 5s

0 comments on commit 2ed386d

Please sign in to comment.