Skip to content

Commit 45d5878

Browse files
authored
docs: Update README.md and command description (#200)
* Update README.md * docs: Use official formula instead of brew tap * docs: Add command sample image * docs: nyan is now added homebrew-core * chore: Update descriptions
1 parent f7f8b3b commit 45d5878

File tree

4 files changed

+36
-10
lines changed

4 files changed

+36
-10
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- name: Normal Output Test
3333
run: go run main.go -- main.go
3434
# ref. https://github.com/gfx/example-github-actions-with-tty
35-
- name: Colored Output Test
35+
- name: Colorized Output Test
3636
if: runner.os == 'Linux'
3737
shell: 'script -q -e -c "bash {0}"'
3838
run: go run main.go -- main.go

.goreleaser.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ builds:
3030
- -s -w -X github.com/toshimaru/nyan/cmd.version={{.Version}}
3131

3232
checksum:
33-
name_template: 'checksums.txt'
33+
name_template: "checksums.txt"
3434

3535
changelog:
3636
sort: asc
@@ -58,16 +58,15 @@ changelog:
5858
order: 99
5959

6060
archives:
61-
- name_template: '{{ .ProjectName }}_{{ title .Os }}_{{ .Arch }}'
61+
- name_template: "{{ .ProjectName }}_{{ title .Os }}_{{ .Arch }}"
6262
format_overrides:
6363
- goos: windows
64-
formats: [ zip ]
64+
formats: [zip]
6565

6666
homebrew_casks:
6767
- repository:
6868
owner: toshimaru
6969
name: homebrew-nyan
70-
description: Colored cat command which supports syntax highlighting
70+
description: Colorizing `cat` command with syntax highlighting
7171
homepage: https://github.com/toshimaru/nyan
7272
license: MIT
73-

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# nyan
88

9-
Colored `cat` command which supports syntax highlighting.
9+
Colorizing `cat` command with syntax highlighting.
1010

1111
![OG image for nyan command](https://repository-images.githubusercontent.com/195893425/0a7e7dfc-3a80-49d5-8193-5482fe2e7848)
1212

@@ -15,9 +15,34 @@ Colored `cat` command which supports syntax highlighting.
1515
### Homebrew
1616

1717
```console
18-
$ brew install toshimaru/nyan/nyan
18+
$ brew install nyan
1919
```
2020

21+
> [!NOTE]
22+
> As of v1.2.0, `nyan` has been merged into [homebrew-core](https://github.com/Homebrew/homebrew-core). :tada:
23+
>
24+
> If you see:
25+
>
26+
> ```
27+
> Error: nyan was installed from the toshimaru/nyan tap
28+
> ```
29+
>
30+
> simply reinstall from the core tap:
31+
>
32+
> ```console
33+
> $ brew uninstall nyan
34+
> $ brew install nyan
35+
> ```
36+
37+
<details>
38+
<summary><strong>Install via Homebrew Tap</strong></summary>
39+
40+
```console
41+
$ brew install --cask toshimaru/nyan/nyan
42+
```
43+
44+
</details>
45+
2146
### go get
2247

2348
```console
@@ -36,6 +61,8 @@ $ go install github.com/toshimaru/nyan@latest
3661
$ nyan FILE
3762
```
3863

64+
![nyan command sample](https://github.com/user-attachments/assets/ba6a3248-3f8f-49ab-b1b1-1e6c4a084a99)
65+
3966
### Available Options
4067

4168
| Option | Description |

cmd/root.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ var (
2828

2929
var rootCmd = &cobra.Command{
3030
Use: "nyan [flags] [FILE]...",
31-
Short: "Colored cat command.",
32-
Long: "Colored cat command which supports syntax highlighting.",
31+
Short: "Colorizing cat command.",
32+
Long: "Colorizing `cat` command with syntax highlighting.",
3333
Example: `$ nyan FILE
3434
$ nyan FILE1 FILE2 FILE3
3535
$ nyan -t solarized-dark FILE

0 commit comments

Comments
 (0)