Skip to content

Commit

Permalink
docs: Update readme and add images
Browse files Browse the repository at this point in the history
  • Loading branch information
hackinghieser committed Dec 28, 2024
1 parent 5fb2d84 commit 69c1fba
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -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

- <http://clef-json.org>

- <https://messagetemplates.org>

- <https://ratatui.rs>
Binary file added images/clever.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 69c1fba

Please sign in to comment.