diff --git a/License b/License new file mode 100644 index 0000000..3ed97bf --- /dev/null +++ b/License @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index 17051b4..8c450ab 100644 --- a/README.md +++ b/README.md @@ -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) +
+ + + +
-![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 ` -![image-20240102005421026](https://cdn.just-plain.fun/img/image-20240102005421026.png) \ No newline at end of file +## How to Use + +1. Build from source (recommended, but requires cargo install) + + ```shell + git clone git@github.com: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 \ No newline at end of file