Skip to content

Commit

Permalink
docs: update readme & add license
Browse files Browse the repository at this point in the history
  • Loading branch information
YiNNx committed Jan 2, 2024
1 parent 49236fc commit 1e52adf
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 5 deletions.
21 changes: 21 additions & 0 deletions License
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 evgo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,34 @@
# cmd-wrapped

Find what your 2023 looks like in command-line !
Find out what the past year looks like in command-line!

![image-20240102005246069](https://cdn.just-plain.fun/img/image-20240102005246069.png)
<div align="center">
<img src="https://cdn.just-plain.fun/img/image-20240102210902286.png" width="85%" />
<img src="https://cdn.just-plain.fun/img/image-20240102211015987.png" width="85%" />
<img src="https://cdn.just-plain.fun/img/image-20240102211113761.png" width="85%" />
</div>

![image-20240102005614044](https://cdn.just-plain.fun/img/image-20240102005614044.png)
## Features

![image-20240102005342687](https://cdn.just-plain.fun/img/image-20240102005342687.png)
- Support Zsh & Bash
- Get your cmd wrapped for any specific year by argument `./cmd-wrapped <year>`

![image-20240102005421026](https://cdn.just-plain.fun/img/image-20240102005421026.png)
## How to Use

1. Build from source (recommended, but requires cargo install)

```shell
git clone [email protected]:YiNNx/cmd-wrapped.git
cd cmd-wrapped
# for the past year
cargo run
# or for any specific year
cargo run -- 2022
```

2. Download from Release

## Credits & License

- Special thanks to [jyi2ya](https://github.com/jyi2ya) for the original idea :kissing_heart:
- License: MIT

0 comments on commit 1e52adf

Please sign in to comment.