Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YiNNx committed Aug 31, 2024
1 parent 2c25140 commit 29ea3a4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 22 deletions.
16 changes: 8 additions & 8 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@
</p>
<div align="center">
<h1>cmd-wrapped</h1>
<p>在命令行中查看你的过去一年!<br/><p/>
<p>👩‍💻 Rust-Based Unix Shell History Analyzer<br/><p/>
<div>
<img alt="Stars" src="https://img.shields.io/github/stars/YiNNx/cmd-wrapped?style=flat-square&color=87e3dd&labelColor=444B5A">
&nbsp;
<img alt="Release" src="https://img.shields.io/github/v/release/YiNNx/cmd-wrapped?style=flat-square&color=87e3dd&labelColor=444B5A">
</div>
<img src="./assets/image-20240105171950987.png" width="80%" />
</div>


Expand All @@ -23,8 +22,6 @@
- fish
- atuin

- 封面的 Ferris <img style="width:25px;vertical-align: bottom;" src="./assets/ferris_hello.gif" />

## 如何使用

### 安装
Expand Down Expand Up @@ -54,11 +51,14 @@ yay -S cmd-wrapped
### 参数

```shell
cmd-wrapped [<year>] [-s <shell>]
# fetch current stats
cmd-wrapped

# fetch annual shell history stats for a specific year
cmd-wrapped 2024

# e.g.
cmd-wrapped # for the past year & current shell
cmd-wrapped 2024 -s zsh # specify the year & the shell type
# specify the target shell
cmd-wrapped -s <shell>
```

所支持的 `<shell>` 选项:`zsh`, `bash`, `fish`, `atuin`.
Expand Down
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,24 @@
</p>
<div align="center">
<h1>cmd-wrapped</h1>
<p>Find out what the past year looks like in command line!<br/><p/>
<p>👩‍💻 Rust-Based Unix Shell History Analyzer<br/><p/>
<div>
<img alt="Stars" src="https://img.shields.io/github/stars/YiNNx/cmd-wrapped?style=flat-square&color=87e3dd&labelColor=444B5A">
&nbsp;
<img alt="Release" src="https://img.shields.io/github/v/release/YiNNx/cmd-wrapped?style=flat-square&color=87e3dd&labelColor=444B5A">
</div>
<img src="./assets/image-20240105171950987.png" width="80%" />
</div>




## Features

- Analyze the commandline activity distribution for months, weekdays and hours, as well as frequently-used commands over the past years.
- Analyze the commandline activity distribution for months, days and hours
- Github-style command distribution graph
- Supported shell / history tool:
- zsh
- bash
- fish
- atuin

- A cute Ferris on the cover <img style="width:25px;vertical-align: bottom;" src="./assets/ferris_hello.gif" />

## How to Use

### Installation
Expand All @@ -36,7 +30,7 @@
```shell
cargo install cmd-wrapped
```

- #### Download from [Release](https://github.com/YiNNx/cmd-wrapped/releases/latest)

Unzip, chmod and run the binary file in the terminal.
Expand All @@ -56,11 +50,14 @@ yay -S cmd-wrapped
### Usage

```shell
cmd-wrapped [<year>] [-s <shell>]
# fetch current stats
cmd-wrapped

# fetch annual shell history stats for a specific year
cmd-wrapped 2024

# e.g.
cmd-wrapped # for the past year & current shell
cmd-wrapped 2024 -s zsh # specify the year & the shell type
# specify the target shell
cmd-wrapped -s <shell>
```

Supported options for `<shell>` : `zsh`, `bash`, `fish`, `atuin`.
Expand All @@ -77,4 +74,4 @@ Supported options for `<shell>` : `zsh`, `bash`, `fish`, `atuin`.
## Credits & License

- Special thanks to [@jyi2ya](https://github.com/jyi2ya) for the cooool idea!
- License: [MIT](https://github.com/YiNNx/cmd-wrapped/blob/master/LICENSE)
- License: [MIT](https://github.com/YiNNx/cmd-wrapped/blob/master/LICENSE)

0 comments on commit 29ea3a4

Please sign in to comment.