diff --git a/README.md b/README.md new file mode 100644 index 0000000..0aa913d --- /dev/null +++ b/README.md @@ -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 +``` + +![](./docs/user.gif) + +## LICENSE + +[MIT](./LICENSE) diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..8fd27a3 Binary files /dev/null and b/docs/demo.gif differ diff --git a/docs/user.gif b/docs/user.gif new file mode 100644 index 0000000..b4ecfcd Binary files /dev/null and b/docs/user.gif differ diff --git a/tapes/demo.tape b/tapes/demo.tape new file mode 100644 index 0000000..3ccf743 --- /dev/null +++ b/tapes/demo.tape @@ -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 diff --git a/tapes/user.tape b/tapes/user.tape new file mode 100644 index 0000000..a025e23 --- /dev/null +++ b/tapes/user.tape @@ -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