diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..7f48d2f --- /dev/null +++ b/Readme.md @@ -0,0 +1,42 @@ +[![Clever Release Build](https://github.com/AlexanderHieser/clever/actions/workflows/release_build.yml/badge.svg)](https://github.com/AlexanderHieser/clever/actions/workflows/release_build.yml) +[![Clever Debug Build](https://github.com/hackinghieser/clever/actions/workflows/debug_build.yml/badge.svg?event=push)](https://github.com/hackinghieser/clever/actions/workflows/debug_build.yml) + +# clever + +Clever is a simple cli application to view \*.clef logs. Written in Rust & powered by Ratatui + +![clever](./images/clever.gif) + +# Installation + +Currently clever cannot be installed through any package manager. Contributions regarding this are welcomed. + +To install it manually, just download from the release page and add it to our path variable. + +# Usage + +Simply by: + +`clever path\to\file` + +a simple cli is also planned to nicly format the logs. Use: + +`clever --help` + +to print the available cli commands & options. + +# Notes + +Currently only templates using {PropertyName} are rendering, support for index rendering and other message template features is planned. + +# Contribution + +Simply open a PR. Repo is using convetional commits, please stick to it if you want to contribute. Apart from this, nothing special to consider right now. + +# Links + +- + +- + +- diff --git a/images/clever.gif b/images/clever.gif new file mode 100644 index 0000000..4830be0 Binary files /dev/null and b/images/clever.gif differ