diff options
| author | Fuwn <[email protected]> | 2024-01-18 03:42:19 -0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-01-18 03:42:19 -0800 |
| commit | 331bf7878a860d18f8bed30b502cb146f6d543e2 (patch) | |
| tree | 6ef1123f84189ef1ad0b8cb2adf8d8f3f0177666 | |
| parent | feat: initial release (diff) | |
| download | tama-331bf7878a860d18f8bed30b502cb146f6d543e2.tar.xz tama-331bf7878a860d18f8bed30b502cb146f6d543e2.zip | |
docs: create readme
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7c54d83 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# 📺 `tama` + +A command-line client for searching [Hiruki](https://hiruki.xyz) + +## Usage + +You can download the script and run it locally, but I'd recommend fetching and +running it from GitHub to ensure that you are always on the latest version: + +```shell +bash <(curl -s "https://raw.githubusercontent.com/Fuwn/tama/main/tama") +``` + +> Hint: Alias this in your shell profile: `alias tama="bash <(curl -s "https://raw.githubusercontent.com/Fuwn/tama/main/tama")"` + +### `--help` + +```text +tama - Command-line Hiruki Client + +Usage: + tama COMMAND + tama [COMMAND] --help | -h + tama --version | -v + +Commands: + trending + popular + upcoming + search +``` + +### Dependencies + +- [curl](https://curl.se/) +- [jq](https://jqlang.github.io/jq/) +- [mdcat](https://github.com/swsnr/mdcat) + +## Licence + +This project is licensed with the [GNU General Public License v3.0](LICENSE). |